Get Started

1. Prerequisites

• Node.js - Server
• MySQL - Relational Database Management System
• Visual Studio Code - Code Editor
• Git - Git
• GitHub Desktop - Github Access tool

2. Installation

On the command prompt run the following commands:

$ git clone https://github.com/learning-zone/my-store.git
$ cd my-store
$ 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
$ npm ls <package-name> # List dependent package

3. Usage

URL : http://localhost:3000/

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

4. App Credential

Username: pradeep.vwa@gmail.com
Password: P@ssw0rd

5. Technologies used in project

Technology	Description
Express	Web framework for Node.js
Bookshelf	JavaScript ORM for Node.js
Knex	SQL Query Builder
jsonwebtoken	JSON Web Tokens ( jwt )
Winston	Logging Library
Joi	Object schema validation
swagger-jsdoc	API documentation
swagger-ui	API documentation
React	JavaScript library for building user interfaces
Redux	Predictable state container
Material-UI	CSS framework
Redux Form	Redux Form
React-Router	Declarative routing for React
Axios	Promise based HTTP client
dotenv	Environment configuration
ESLint	Code linting tool
Prettier	Code formatter
Grunt	JavaScript Task Runner