/mern-boilerplate

Express, MySQL, React/Redux, NodeJs Application Boilerplate

Primary LanguageJavaScript

Express, React/Redux, MySQL Boilerplate

Get Started

1. Prerequisites

  • NodeJs
  • NPM - Node package manager
  • MySQL - Relational database management system (RDBMS)

2. Installation

On the command prompt run the following commands:

 $ git clone https://github.com/Bikranshu/express-react-boilerplate.git
 $ cd express-react-boilerplate
 $ cp .env.example .env (edit it with your secret key and database information)
 $ npm install
 $ npm run migrate

Finally, start and build the application:

$ npm run build (For development)
$ npm run build:prod (For production)

List of NPM Commands:

$ npm run lint       # linting
$ npm run clean      # remove dist and node_modules folder and install dependencies

3. Usage

URL : http://localhost:3000/

Navigate to http://localhost:3000/swagger/ for the API documentation.

4. Useful Link

  • Web framework for Node.js - Express
  • JavaScript ORM for Node.js - Bookshelf
  • SQL Query Builder for Postgres, MSSQL, MySQL, MariaDB, SQLite3, and Oracle - Knex
  • JSON Web Tokens(jwt) - jsonwebtoken
  • Logging Library - Winston
  • Object schema validation - Joi
  • API documentation using swagger-jsdoc and swagger-ui
  • JavaScript library for building user interfaces - React
  • Predictable state container - Redux
  • A React component library implementing Google's Material Design - Material-UI
  • Redux Form - Redux Form
  • Declarative routing for React - React-Router
  • Promise based HTTP client - Axios
  • Environment configuration - dotenv
  • Code linting tool - ESLint
  • Code formatter - Prettier