Node Api Server ( Seed )

An simple nodejs api server.

Project structure

.
├── app.js
├── router.js
├── controllers
│   └── index.js
│   └── system.js
├── infras
│   └── index.js
│   └── mysql-client.js
├── libs
│   └── index.js
│   └── middleware.js
├── models
│   └── index.js
│   └── sql_model.js
├── utils
│   └── index.js
│   └── errors.js
└── package.json

Usage

For running

Install dependence packages by command

$ npm install

Install nodemon (optional) on golbal scope in your host machine (flag -g) using npm

Start api server

$ npm start

or

$ npm run dev

(if you don't have nodemon start server by node app.js)

Note

Starter kit has ping endpoint which test the availability of connection between this node js server and the sql database defined under $DATABASE_SQL_URL env var in your shell. Please run up a mysql server to make this check pass.

You can startup a mysql server with docker by using docker-compose manifest included in this boilerplate.

$ docker-compose up -d --build

Done! :)))