Direct Livestock Backend

Get Started

1. Prerequisites

• NodeJs
• NPM - Node package manager

2. Installation

On the command prompt run the following commands:

 $ git clone https://github.com/DLivestock/Direct_Livestock_Backend.git
 $ cd Direct_Livestock_Backend
 Create MySQL Database(dbName : direct_livestock)
 $ 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
• Code linting tool - ESLint