Skip to content

Commit

Permalink
♻️ Updatedd documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Noé Grangier committed May 21, 2024
1 parent 36a08d3 commit 53db068
Show file tree
Hide file tree
Showing 4 changed files with 8,593 additions and 8,575 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ You can find Graphhopper project here : https://github.com/lonestone/graphhopper

Don't forget to use the correct environnement before pushing your apps in production :

* Check `.env` files
* "baseUrl" in `api/config.json`
- Check `.env` files
- "baseUrl" in `api/config.json`

A new version is automatically deployed on Render when a commit is pushed on main branch.

Expand All @@ -38,6 +38,7 @@ git push origin vX.Y.Z
# Y : add new feature(s)
# Z : minor fix(s)
```

## Staging vs prod

> Warning : staging is the new prod
Expand All @@ -48,9 +49,9 @@ For the application you **must** check what is the current env in `config.json`

For now, please change the url according to the wanted env :

* Prod => "baseUrl": "https://naonair-api-staging.onrender.com/"
* Preprod => "baseUrl": "https://naonair-api-preprod.onrender.com"
* local => "baseUrl": "http://localhost:3001/"
- Prod => "baseUrl": "https://naonair-api-staging.onrender.com/"
- Preprod => "baseUrl": "https://naonair-api-preprod.onrender.com"
- local => "baseUrl": "http://localhost:3001/"

## Docker

Expand Down Expand Up @@ -101,6 +102,11 @@ $ cd api
# copy example to right file (don't commit it!)
$ cp .env.example .env
# go in app folder
$ cd ../app/
# copy example to right file (don't commit it!)
$ cp .env.example .env
```

Then, fill right properties
Expand Down Expand Up @@ -139,6 +145,8 @@ PASS_KEY : Token used to be connected on backoffice
JWT_KEY : Key to jwt token generation (Keep it secret)
```

Add the `firebase.json` file at the root of the `api` folder.

## DTOs

DTOs, as (Data Transfer Object), are defined in /dtos. It permits typing between api and front app.
Expand Down
1 change: 1 addition & 0 deletions app/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
POLLEN_TOKEN=
Loading

0 comments on commit 53db068

Please sign in to comment.