Skip to content

Commit

Permalink
🐛 style: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
perebaj committed Oct 2, 2023
1 parent b923d00 commit 6973961
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ If you want to run this project locally you must set up these environment variab

This could be made in the [docker-compose.yml](./docker-compose.yaml)

**Note:** To create your own Google Client for OAuth2.0, access the following [link](https://console.cloud.google.com/apis/credentials), without these secrets, the service won't run locally, but it's possible to access it using the link present in the repository details on GitHub

## Get Started

To start the service locally, you can type `make dev/start` and after that you can use the docker container IP to play around the routes, `make ip`
Expand All @@ -30,6 +32,8 @@ Request example:

curl (make ip)

Or just accessing `http:/localhost:8080`

## Command line

All commands are synthesized in the Makefile `make help`, to start the development environment, just run:
Expand Down

0 comments on commit 6973961

Please sign in to comment.