1.0.8 ā¢ Published 12 months ago
express-server-kit v1.0.8
express-server-kit
Express-Server Boilerplate
A boilerplate/starter project for quickly building RESTful APIs using Node.js, Express, and Mongoose.
By running a single command, you will get a production-ready Node.js app installed and fully configured on your machine.
Installation š
$ npm install -g express-server-kit
Quick Start šāāļø
The quickest way to get started with express is to utilize the executable express-server
to generate an application as shown below:
Create (and start) the app in current folder:
$ express-server .
$ npm run dev
OR, create (and start) the app (in project_name
folder):
$ express-server project_name
$ cd project_name
$ npm run dev
This will basically create this structure in your folder
.....................................
āāā .env
āāā .gitignore
āāā app.js
āāā node_modules
| āāā ....
āāā package-lock.json
āāā package.json
āāā routes
| āāā indexRoute.js
| āāā userRoutes.js
āāā controllers
| āāā indexControllers.js
| āāā userControllers.js.js
āāā models
| āāā userModels.js
āāā views
| āāā index.html
.....................................
Environment Variables
The environment variables can be found and modified in the .env
file. They come with these default values:
#port
PORT=4000
#mongodb uri
URI=mongodb://127.0.0.1:27017
#mongodb database
DB=my_database
What dependencies it installs ?
- express - express framework
- mongoose - Mongoose(MongoDB object modeling tool)
- dotenv - for env variables
- cors - enable CORS
- http-errors - to create http errors
- morgan - to log http requests
- nodemon (dev) - monitors changes in files
Author āļø
Contribute š¤
You can fork this repo and send me a PR.