node-backend-example/README.md

README.md Generator for Node.js Application

Setting up the Application

To set up this Node.js application, follow the instructions below:

1. Copy .env.example to `.env Open your terminal and navigate to your project's root directory.

   $ cp .env.example .env
   

2. Modify the .env file if you wish. The DB_URL should already be set correctly.

3. Start the postgres database:

   $ docker-compose up -d
   

4. Install the packages

$ npm i

5. Run the tests

$ npm run test

6. Start the Express application.

$ npm run serve