This is a simple boilerplate for creating APIs with NodeJs express framework. Here API access token encapsulated/encrypted with JWT token based system.
- Sample API ready for login
- API middlewares for normal user and Admin user
- ES6 import/export available to the user with spread operators
- Deploy your app with cluster (cluster implementation is integrated)
- jest test configured
- add test case for mock database model/functions to test controllers functions
You can download this repo or clone using below command. (folder-name will be project folder in which you want to start your project).
git clone https://github.com/binitghetiya/express-sequelize-api-boilerplate.git <folder-name>
or from Download Zip
https://github.com/binitghetiya/express-sequelize-api-boilerplate
Once you clone or download project go into you folder
now cope .env.local file to .env file
> npm install or yarn install (this will install all dependent libraries)
Create new database (let's say i'm going to use mysql and my database name is express-sequelize-api). so in my .env file will set below parameters.
DB_HOST=localhost # database connection host
DB_USER=root # database username
DB_PASS=secret@123 # database password
DB_NAME=express-sequelize-api # database name
DB_DIALECT=mysql # database dialect
DB_PORT=3306 # database port
some other inportant parameters/keys in .env file
APP_HOST=localhost # application host name
APP_PORT=3000 # application port
SECRET=secret # secret key for encrypt/decrypt JWT token
are you going to user google captcha while register? then also add/update in .env
IS_GOOGLE_AUTH_ENABLE=true # enable google captcha
GOOGLE_CAPTCHA_SECRET_CLIENT=secret
GOOGLE_CAPTCHA_SECRET_SERVER=secret
GOOGLE_CAPTCHA_URL=https://www.google.com/recaptcha/api/siteverify
After creating database and updating .env file run below commands
> node_modules/.bin/sequelize db:migrate
> node_modules/.bin/sequelize db:seed:all
Migration will create table users and seed some default users
- users - this is normal user table with some required fields like (firstName, lastName, email, password, and isAdmin) Seeders will create one new client entry in application and 2 users entry one admin and one normal user.
npm start to run your project
Everythig is setup and you are good to go now. Happy Coding :)
> node_modules/.bin/sequelize model:generate --name User --attributes firstName:string,lastName:string,email:string
> node_modules/.bin/sequelize db:migrate
> node_modules/.bin/sequelize db:migrate:undo
> node_modules/.bin/sequelize db:migrate:undo:all --to XXXXXXXXXXXXXX-create-posts.js
> node_modules/.bin/sequelize seed:generate --name demo-user
> rm -rf .git (Remove git folder so you can use your own git/bitbucket)
> ApiAuth this will check user access token that we have return in login response.
> AdminAuth this will check admin auth and it's access.
Currently we have added 3 routing files
> pub.js # public routing access everyone can access this APIs
> api.js # only logged in user/ with vaild token user can access this routes
> admin.js # only admin can access with valid token
here attached link of postman collection you can download and check in local https://www.getpostman.com/collections/4d415740f37a864d9afc
> POST : http:localhost:8000/pub/login
> Payload: email, password
> Response :
{
"code": 200,
"data": {
"user": {
"id": 1,
"firstName": "Admin",
"lastName": "User",
"email": "[email protected]",
"profilePic": null,
"isAdmin": true,
"verifyToken": null,
"isVerified": true,
"createdAt": "2019-05-27T07:15:12.000Z",
"updatedAt": "2019-05-27T07:15:12.000Z"
},
"token": "secret token"
},
"success": true
}
> GET : http:localhost:8000/api/me
> Headers :
x-token (access token)
> Response :
{
"code": 200,
"data": {
"user": {
"id": 1,
"firstName": "Admin",
"lastName": "User",
"email": "[email protected]",
"profilePic": null,
"isVerified": true,
"createdAt": "2019-05-27T07:15:12.000Z",
"updatedAt": "2019-05-27T07:15:12.000Z"
}
},
"success": true
}
{
"success": true,
"code": 200,
"data": "object or array"
}
{
"success": false,
"code": 500,
"errorMessage": "Incorrect Email Id/Password",
"error": {},
"data": null
}
> suggestions and improvements are most welcome
- Follow @me on Twitter
- Email [email protected]