DEV Community

Cover image for Set up a modern Node.js API service by running one command
Md Zinnatul Islam Morol
Md Zinnatul Islam Morol

Posted on

Set up a modern Node.js API service by running one command

#javascript #beginners #node #api

Node Starter

Node-starter is a command-line application, here you can easily create your node.js project structure.

Installation

Install my-project with npm

  npx nano-app my-project
  cd my-project
Enter fullscreen mode Exit fullscreen mode

It will create a directory called my-project inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies:

my-project
├── package.json
├── package-lock.json
├── .prettierrc
├── .prettierignore
├── .gitignore
├── .env.production
├── .env.development
├── .babelrc
├── node_modules
└── src
    ├── config
        ├── cloudinary.js
        ├── database.js
        ├── passport.js
        └── sendEmail.js
    ├── controllers
        └── authController.js
    ├── middlewares
        ├── authorizedUser.js
        └── google.js
    ├── models
        ├── auditLogs.js
        ├── userRoleMaps.js
        ├── users.js
        └── validations.js
    ├── routes
        ├── authRouter.js
        └── router.js
    ├── utils
        ├── errors
            └── globalErrorHandler.js
        ├── responses
            ├── sendData.js
            ├── sendMessage.js
            └── sendResponse.js
        ├── templates
            ├── forgotMail.js
            └── signUpMail.js
        ├── createJWT.js
        └── createMFA.js
    ├── app.js
    └── server.js
Enter fullscreen mode Exit fullscreen mode

Features

  • ES6+ configuration (Babel)
  • Better error handling
  • Clean code structure
  • Google authentication (Passport strategy)
  • Email authentication with OTP verification (Sent mail using Google Gmail)
  • Implement MFA using speakeasy
  • MFA QR code images stored in Cloudinary
  • Forgot Password via mail
  • Modern data validation using Joi
  • Forgot password mail template
  • OTP validation mail template

Environment Variables

To run this project, you will need to add the following environment variables to your .env.development (Development mode) or .env.production (Production mode) file

  • DB_NAME
  • DB_USER
  • DB_PASS
  • HOST
  • SCHEMA

If you want to store MFA QR code at Cloudinary

  • CLOUD_NAME
  • CLOUD_KEY
  • CLOUD_SECRET

If you want to use google login Google console

  • GOOGLE_CLIENT_ID
  • GOOGLE_CLIENT_SECRET
  • GOOGLE_CALLBACK_URL

If you want to use email verification

  • EMAIL
  • EMAIL_PASS (App password)

API Reference

Google Log In 

  Redirect /api/v1/auth/google
Enter fullscreen mode Exit fullscreen mode

For google login you need to set your FrontEnd URL at .env.development or .env.production [FRONT_END]

Sign Up 

  POST /api/v1/auth/signup
Enter fullscreen mode Exit fullscreen mode
Body Type Description
f_name string Required. Your first name
l_name string Required. Your last name
email string Required. Your email
phone string Required. Your phone number
password string Required. Your password

Sign In 

  POST /api/v1/auth/signin
Enter fullscreen mode Exit fullscreen mode
Body Type Description
email string Required. Your email
password string Required. Your password

Resent OTP 

  POST /api/v1/auth/resent-otp
Enter fullscreen mode Exit fullscreen mode
Body Type Description
email string Required. Your email

Verify OTP 

  POST /api/v1/auth/verify-otp
Enter fullscreen mode Exit fullscreen mode
Body Type Description
email string Required. Your email
otp string Required. Your otp

Verify MFA 

  POST /api/v1/auth/verify-mfa
Enter fullscreen mode Exit fullscreen mode
Body Type Description
id int Required. Your user id
token string Required. Your mfa token

Forgot Password 

  POST /api/v1/auth/forgot-password
Enter fullscreen mode Exit fullscreen mode
Body Type Description
email string Required. Your email

Reset Password 

  POST /api/v1/auth/reset-password
Enter fullscreen mode Exit fullscreen mode
Body Type Description
reset_link string Required. Reset link
password string Required. Your password

Get Profile 

  GET /api/v1/auth/profile
Enter fullscreen mode Exit fullscreen mode
Parameter Type Description
Authorization string Required. Your JWT token

Run Locally

Install dependencies

  npm install
Enter fullscreen mode Exit fullscreen mode

Start the server

  npm run dev
Enter fullscreen mode Exit fullscreen mode

Deployment

To deploy this project run

  npm run start
Enter fullscreen mode Exit fullscreen mode

Usage/Examples 

npx nano-app api
Enter fullscreen mode Exit fullscreen mode

Part 1

Part 2

Part 3

Tech Stack

Server: Node, Express

Authors

Feedback

If you have any feedback, please reach out to us at morolswediu@gmail.com

Support

For support, email morolswediu@gmail.com

License

MIT

Source code: https://github.com/jinnatul/node-starter

If you like, Give a star ⭐

Top comments (0)

Read next

rappernamegenerator profile image

** Rapper name generator:

Rappernamegenerator -

alakkadshaw profile image

How to Use TURN Server with Node WebRTC Library

alakkadshaw -

dgihost profile image

Difference between SEO and Digital Marketing

Gurpinder Singh -

dhyaneshsiddhartha15 profile image

Node js AsyncHandler

Dhyanesh Siddhartha -