Codebase for REST API in NodeJS

This codebase help a new NodeJS developer in developing a REST API using NodeJS. This codebase included with some pre bundle service or helper like authentication, logging, and predefined configuration.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Prequisites package:

• NodeJS (NodeJS Programming Language) Version 8.xx or higher
• NPM (NodeJS Dependency Package Management Tool) Version 5.xx or higher

Optional package:

• Docker (Application Containerization)

Installing

Below is the instructions to make this codebase running:

• Pull the codebase from this repository

git clone -b master https://github.com/dimaskiddo/codebase-nodejs-rest.git
cd codebase-nodejs-rest

• Remove any related git configuration

rm -rf .git

• Run following command to pull dependecies package

npm install

• Until this step you already can run this code by using this command

npm start

Running The Tests

Currently the test is not ready yet :)

Deployment

Make sure your your js script does not relate to github.com/dimaskiddo/codebase-nodejs-rest anymore. To build this codebase to binaries for distribution purposes you can use any external NodeJS builder like pkg

Built With

• NodeJS - NodeJS Programming Languange
• NPM - NodeJS Dependency Package Management Tool
• Docker - Application Containerization

Authors

• Dimas Restu Hidayanto - Initial Work - DimasKiddo

See also the list of contributors who participated in this project

Annotation

You can seek more information for the npm command parameters in the package.json