Skip to content

erijonhson/node-api-base

Repository files navigation

node-api-base

Steps are necessary to get the application up and running:

Preparing environment

Install Node:

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E sh -
sudo apt-get install -y nodejs

Verifing if node version is 8.x

node -v

Databases things

In the work directory, download dependencies:

npm install

To populate development database:

  • run the application
  • open another terminal (Ctrl + Alt + T) and go to server folder (e.g. cd /server)
    npm run seed
    

Test and Coverage

To run automated tests, run:

npm run test

To view code coverage, run:

npm run coverage

So, go to coverage folder (cd /server/coverage) and open the index.html in a browser.

Run the server

So every time you need to start the app, run:

npm start

Application started on http://localhost:3030

Swagger API Docs on http://localhost:3030/swagger-ui.html

Subliminal message

Tip 1: install vscode

Tip 2: install eslint (npm install -g eslint)

and

Be happy during development ;)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published