Skip to content

If you start new project our clone help you to setup basic structure of project in few seconds. Take clone of MVC Basic project and start you development fast

Notifications You must be signed in to change notification settings

quytechabhinav/MVC_Node_API

Repository files navigation

MVC_Node_API

If you start new project our clone help you to setup basic structure of project in few seconds. Take clone of MVC Basic project and start you development fast. A Complete MVC structure of node.js project in which we include following points:

  • MVC Structure
  • .env file
  • bcryptjs for password
  • jsonwebtoken for authentication
  • Mysql
  • express
  • knex ORM For MySQL
  • express-validator for validation
  • swagger for API documentation
  • nodemon for devlopment
  • Migration

API Module

  • Login API
  • Signup
  • Get all user
  • Edit user profile

Requirements

For development, you will only need Node.js and a node global package, Yarn, installed in your environement.

Node

  • Node installation on Windows

    Just go on official Node.js website and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).

  • Node installation on Ubuntu

    You can install nodejs and npm easily with apt install, just run the following commands.

    $ sudo apt install nodejs
    $ sudo apt install npm
    
  • Other Operating Systems

    You can find more information about the installation on the official Node.js website and the official NPM website.

If the installation was successful, you should be able to run the following command.

$ node --version
v10.19.0

$ npm --version
6.14.4

If you need to update npm, you can make it using npm! Cool right? After running the following command, just open again the command line and be happy.

$ npm install npm -g

Yarn installation

After installing node, this project will need yarn too, so just run the following command.

  $ npm install -g yarn

Install

$ git clone https://github.com/quytechabhinav/MVC_Node_API.git
$ cd MVC_Node_API
$ npm install

Configure app

Running the project

$ npm start