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

🐛 style: docs #23

Merged
merged 1 commit into from
Oct 2, 2023
Merged

🐛 style: docs #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
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
Loading