41 lines
643 B
Markdown
41 lines
643 B
Markdown
# 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.
|
|
|
|
```bash
|
|
$ 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:
|
|
|
|
```shell
|
|
$ docker-compose up -d
|
|
```
|
|
|
|
4. Install the packages
|
|
|
|
```shell
|
|
$ npm i
|
|
```
|
|
|
|
5. Run the tests
|
|
|
|
```shell
|
|
$ npm run test
|
|
```
|
|
|
|
6. Start the Express application.
|
|
|
|
```shell
|
|
$ npm run serve
|
|
```
|
|
|