Skip to content

Commit

Permalink
Update backend README (#357)
Browse files Browse the repository at this point in the history 
* added table to frontend readme

* added .env vars to the README

* added readme vars

* changes

* added explanation

* removed changes to frontend readme to exclude it from this pr

* remove code verifier

* added JWT application

* POST_HOST name

* added rfc link

* added microsoft admin link

* updated link
  • Loading branch information
@Gerwoud
Gerwoud authored May 20, 2024
1 parent e97d2b4 commit 5597424
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions backend/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,18 @@ the regular base application.
The project requires a couple of environment variables to run, if you want to develop on this codebase.
Setting values for these variables can be done with a method to your own liking.

| Variable | Description |
|-------------------|----------------------------------------------------------------|
| DB_HOST | Url of where the database is located |
| POSTGRES_USER | Name of the user, needed to login to the postgres database |
| POSTGRES_PASSWORD | Password of the user, needed to login to the postgres database |
| POSTGRES_HOST | IP adress of the postgres database |
| POSTGRES_DB | Name of the postgres database |
| API_HOST | Location of the API root |
| Variable | Description |
|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| POSTGRES_USER | Name of the user, needed to login to the postgres database |
| POSTGRES_PASSWORD | Password of the user, needed to login to the postgres database |
| POSTGRES_HOST | Location of the postgres database |
| POSTGRES_DB | Name of the postgres database |
| API_HOST | Location of the API root |
| CLIENT_ID | [Client id](https://learn.microsoft.com/nl-nl/entra/identity-platform/v2-protocols) |
| CLIENT_SECRET | Client's secret is your personal secret key for authentication, this can be found at the [Entra ID admin center](https://learn.microsoft.com/en-us/purview/sit-defn-azure-ad-client-secret) |
| JWT_SECRET_KEY | JWT secret key is the key used to encode the JWT's and should be kept secret, because otherwise everyone can create "valid" JWT's for our application. Variable should be a random 32 characters long string, if you need more information please refer to the [RDF documentation](https://www.rfc-editor.org/rfc/rfc4868#page-3) |
| TENANT_ID | [Tenant id](https://learn.microsoft.com/nl-nl/entra/fundamentals/whatis), an ID that is used to identify yourself to the microsoft servic |
| HOMEPAGE_URL | URL of where the website's homepage is located |

All the variables except the last one are for the database setup,
these are needed to make a connection with the database.
Expand Down

0 comments on commit 5597424

Please sign in to comment.