README

What is this repository for?

This is a base structure for Node JS application

How do I get set up?

• Install node

• Install redis

• Install Database mysql

• Clone this repository

• To install the package on package.json just run

  npm install

• Copy .env.example to .env and then set the key based on need

• To run the application for development purposes

  node app or npm start or nodemon

  This will start the application on 127.0.0.1:8432 or please check your .env file

  The Nodemon will automatically restart the server, so you don't need to restart the server manually.

Run Test

Running a test is easy.

1. Set your .env variable of DB_NAME same as DB_TESTING_NAME

   because the server will get the data from DB_NAME while the test case will insert to DB_TESTING_NAME and will cause your test case FAILED

2. Make sure you already run development server and the next step is

3. Run npm test

To run on production environment

To run on production environment please don't use node app or npm start because when something went wrong, your app will stop and it will be a down time for you project. To make the application available or at least nearly zero down time, please use another package to make the app running all the time or at least restart when something went wrong.

Suggested Package on Production Environment

• PM2
• Forever
• etc

Contribution guidelines

• Writing tests
• Code review
• Other guidelines

Who do I talk to?

• Repo owner or admin
• Other community or team contact