https://github.com/prasoonsoni/node-express-starter
Boilerplate for a Node.js + Express.js project
https://github.com/prasoonsoni/node-express-starter
backend bcryptjs expressjs javascript jsonwebtoken mongodb node-express-boilerplate nodejs starter
Last synced: 3 months ago
JSON representation
Boilerplate for a Node.js + Express.js project
- Host: GitHub
- URL: https://github.com/prasoonsoni/node-express-starter
- Owner: prasoonsoni
- License: mit
- Created: 2023-02-14T15:16:35.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-21T10:49:24.000Z (4 months ago)
- Last Synced: 2024-12-21T11:28:56.758Z (4 months ago)
- Topics: backend, bcryptjs, expressjs, javascript, jsonwebtoken, mongodb, node-express-boilerplate, nodejs, starter
- Language: JavaScript
- Homepage:
- Size: 69.3 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 
Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
In order to get a copy of the project you will require you to have Node.js (v14+) and the NPM package manager installed. If you don't have it, you can download the latest version of Node.js from the [official website](https://nodejs.org/en/download/) which also installs the NPM package manager by default.
### Installation
Open the terminal in the folder in which you wish to clone the repository and enter the following command:
```
git clone https://github.com/prasoonsoni/node-express-starter.git
cd node-express-starter
```
Install all the NPM packages:
```
npm i
```
In order to run the server:
```
npm i -D nodemon (One time installation)
npx nodemon
```
> **Note that you will have to add your own `.env` file at the root directory and add your own environment variables for the project to build.**
Following are the environment variables used for backend:
- `MONGO_URI` - MongoDB URI for your database
## 
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/YourAmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some YourAmazingFeature'`)
4. Push to the Branch (`git push origin feature/YourAmazingFeature`)
5. Open a Pull Request
## 👾 Contributors
### Prasoon Soni
[`E-Mail`](mailto:[email protected])
[`LinkedIn`](https://www.linkedin.com/in/prasoonsoni/)