Whenever we start a new project, the codebase tends to repeat over and over among different project. Instead of reinventing the wheel, all the time can be a good solution to use a starter kit, already equipped with a few basic tools and features.

To reinvent the wheel is to duplicate a basic method that has already previously been created or optimized by others. Wikipedia

Table of Contents

• Intro
• Features
• Dependencies
• Dev Dependencies
• Installation
• TODO
• Contributing

Intro

Initially I was using express-generator (still using), but ended-up doing same thing again and again 'user JWT authentication with refresh token and suscription plan' so i decided to create git repository.

[Top]

Features

In order to start with something simple and useful, the starter has a minimum set of features like authentication, clean code structure, and a permissive license(MIT).

• Stateless authentication with JWT allowing for easy horizontal scaling (expiriIn: 2 Minute)
• ESLint Maintain your code quality with ease (Airbnb JavaScript Style).
• MongoDB database
• RefreshToken It can be used to acquire new access Tokens. (expireIn: 7 days)
• Subscription New user initially as 'Trial' and after 7 days as 'Free'.
• Email sendgrid to send welcome and cancellation email.
• Device Limit Only two device login limit.

[Top]

Dependencies

• express (server)
• body-parser (reading body data)
• validator (input validation)
• helmet (Helmet helps you secure your Express apps by setting various HTTP headers.)
• cors (enable CORS)
• mongoose (Mongoose is a MongoDB object modeling tool)
• morgan (HTTP request logger middleware for node.js)
• express-rate-limit (ratelimiting endpoints)
• bcryptjs (password Encryption)
• jsonwebtoken (jwt creation & signing)
• compression (compress response bodies)
• dotenv (It loads environment variables from a .env file into process.env)
• multer (handling multipart/form-data)
• sharp (convert large images in common formats to smaller)
• debug (A tiny JavaScript debugging utility)
• sendgrid (just want to send email)

[Top]

Dev Dependencies

• nodemon (hot-reload)
• eslint (ESLint is a linter for the JavaScript programming language.)
• eslint-config-airbnb-base (Airbnb JavaScript Style)
• jest (Jest is a delightful JavaScript Testing Framework with a focus on simplicity.)
• supertest (HTTP assertions made easy via superagent.)

[Top]

Installation

1. Clone the project git clone https://github.com/vinodnimbalkar/express-api-starter.git.
2. cd express-api-starter
3. Make it your own rm -rf .git && git init && npm init
4. Install dependencies npm install
5. Create a .env file in the root like the .env.example file.
6. For dev you need to have mongodb db locally.
7. For dev - npm run dev
8. For lint - npm run lint
9. For test - npm run test [Top]

TODO

• Signup email verification by sending OTP
• Add docker support

Contributing

Feel free to open an issue (or even better, send a Pull Request). Contributions are very welcome!!
Repository : express-api-starter