/node-rest

Simple folder structure for nodejs microservices

Primary LanguageJavaScriptMIT LicenseMIT

NodeJS with Babel

Read more about Babel from here.

Installation

First, you have to install Yarn.

Then:

Installation

# This will install all dependencies from package.json
$ yarn install

# We use foreman to load the environment variables from `.env` file.
# This is important to prevent accidental commit of sensitive data to github
$ yarn global add foreman

Add/Remove packages

$ yarn add <PACKAGE_NAME>
$ yarn add --dev <PACKAGE_NAME>
$ yarn remove <PACKAGE_NAME>

Environment

For development, store all the environment variable in the .env file. This will be included in .gitignore so that it will not be commited to github. Make sure you create the .env file or the service will not run.

The .env should contain the following:

DB_USER=user
DB_PASS=123456
DB_NAME=testdb
DB_HOST=localhost

FOOD_SERVICE=true

Stop MySQL from your local

Any running MySQL will prevent the app from connecting to the docker container. If you don't stop the MySQL, the following error might appear:

$ error 1044 (42000): access denied for user

Starting the docker image with MySQL DB

$ docker-compose up -d

Start

$ nf start

Test

$ yarn test

Build

$ yarn build