Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhancement/ Add some notes on Readme #911

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

enhancement/ Add some notes on Readme #911

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f7ef09
enhancement/ Add some notes on Readme
davidgk Aug 5, 2022
4f24958
Add REDIS password to allow running test locally
davidgk Aug 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .example.env.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ TYPEORM_MIGRATIONS_RUN = true

REDIS_HOST = localhost
REDIS_PORT = 6379
REDIS_PASSWORD = redis

#TOKEN

Expand Down
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ This project includes the boilerplate for a basic rest-api made in Node.JS with
5. `cp .example.env.test .env.test`
6. Create your DB (i.e. psql for Postgres: `psql -U <user> -h <host> -c "create database <db name>;"`) with same name as your .env file.
7. Run `ENV=[dev, test, prod] yarn db:setup`.
8. Start your server with `ENV=[dev, prod] yarn dev`.
8. Check Redis notes conf for running local.
9. Start your server with `ENV=[dev, prod] yarn dev`.

## Some scripts

Expand Down Expand Up @@ -58,18 +59,23 @@ Also, for configuring the SonarQube keys you can follow the next [steps](https:/
## Running with Docker

### Prerequisites
In order to run the app with Docker, you should install or update to the latest version, we recommend to install [Docker-Desktop](https://docs.docker.com/get-docker/) due to composer and some cool CLI-UI tools are included.
* In order to run the app with Docker, you should install or update to the latest version, we recommend to install [Docker-Desktop](https://docs.docker.com/get-docker/) due to composer and some cool CLI-UI tools are included.
* If you're running it local, don't forget to change REDIS_HOST to localhost into the .env.dev file.

### Development with Docker

The following commands will build and run all you need to start working on the base, without any other installation requirements. Important: if you already have postgres running locally, you'll need to kill the service before run `docker-compose up`.

```
docker-compose --env-file .env.dev build
```

```
docker-compose --env-file .env.dev up
docker-compose --env-file .env.dev up -d --no-recreate
```

if you only want to run redis and postgres locally:
```
docker-compose --env-file .env.dev up -d --no-recreate postgres redis
```

### Deployment with Docker (only for production)
Expand All @@ -89,7 +95,7 @@ docker run --rm --env-file=.env.prod -p 3000:3000 --name node-api node-ts-api-ba
```

### Fix issue at build docker image (dependencies to install bcrypt are not providede in alpine version of node)

Add the following line before the command ` RUN yarn ` in the Dockerfile.

```
Expand Down Expand Up @@ -153,7 +159,7 @@ This is the suggested scaffolding for this project. You can take a look at:
- [tsconfig-paths](https://github.com/dividab/tsconfig-paths#readme) - Utility to register relative paths set at tsconfig file
- [express-rate-limit](https://github.com/nfriedly/express-rate-limit) - Basic rate-limiting middleware used to limit repeated requests to public APIs
- [morgan](https://github.com/expressjs/morgan) - HTTP request logger middleware for node.js
- [nodemailer](github.com/nodemailer/nodemailer) - Module for Node.js to allow the easy email sending.
- [nodemailer](github.com/nodemailer/nodemailer) - Module for Node.js to allow the easy email sending.

## Code Quality

Expand Down