Simplebacks API

NodeJS API service for Simplebacks

Getting Started

Click on the "Clone" button.
You can decide to download the zip file of the app onto the system or you can clone the repository from the terminal
If you decide to clone the repository from the terminal, navigate to a directory of your choice on that terminal.
Using SSH; copy and paste the following below on your terminal [email protected]:chinemelu/simplebks-api.git
Using HTTPS; copy and paste the following below on your terminal https://github.com/chinemelu/simplebks-api.git
Once the folder is cloned onto your computer, cd into the root of the folder and type npm run install in the terminal before pressing enter
To run the program on a development server type npm start and press enter

If the tests are successful, they will complete without failures or errors.

.........
----------------------------------------------------------------------
16 passing

The steps written below are for Heroku Deployment

cd into the root folder of the application
For a first time deployment, type heroku create app-name and press enter
If you are in the application's master branch, you type git push heroku master and press enter
Else, if you are, for example, in a dev branch, you type git push heroku dev:master and press enter
The application will then be deployed onto Heroku and the url of the application will be given once the deployment is complete
For heroku deployment debugging purposes, type heroku logs --tail in the terminal
For subsequent deployments, if changes are made and committed, type git push heroku branch-name:master -f in the terminal and press enter
For more information, see the Heroku documentation

express - Fast, unopinionated, minimalist web framework for Node.js.
dotenv - Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env.
PM2 - PM2 is a production process manager for Node.js applications with a built-in load balancer.
Winston - A logger for just about everything.
Mongodb - NoSQL database
cors - CORS is a node.js package for providing a Connect/Express middleware that can be used to enable CORS with various options.