You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 10, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ An API to manage our #EddieHub community data.
14
14
## Rules
15
15
16
16
- Commits follow the standard [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)
17
-
- Branches should be named as `issue-<issue no>` (e.g. [NestJs](https://github.com/EddieHubCommunity/api/issues/12) issue number is 12)
17
+
- Branches should be named as `issue-<issue no>` (e.g. [NestJS](https://github.com/EddieHubCommunity/api/issues/12) issue number is 12)
18
18
19
19
## Requirements
20
20
@@ -26,11 +26,11 @@ An API to manage our #EddieHub community data.
26
26
27
27
### Gitpod
28
28
29
-
Gitpod is a Service, which provides development environments in the cloud. In case no plan is purchased the reguar`Opensource License` allows to use the service for 50 hours per month for free.
29
+
Gitpod is a Service, which provides development environments in the cloud. In case no plan is purchased the regular`Opensource License` allows to use the service for 50 hours per month for free.
30
30
31
31
All that needs to be done, is logging in to their service with a valid GitHub account.
32
32
33
-
1.[OPTIONAL]Install the Browser Extension from Gitpod.<br>- [Chrome](https://chrome.google.com/webstore/detail/gitpod-always-ready-to-co/dodmmooeoklaejobgleioelladacbeki)<br>- [Firefox](https://addons.mozilla.org/de/firefox/addon/gitpod/)
33
+
1. Install the Browser Extension from Gitpod.[**OPTIONAL**]<br>- [Chrome](https://chrome.google.com/webstore/detail/gitpod-always-ready-to-co/dodmmooeoklaejobgleioelladacbeki)<br>- [Firefox](https://addons.mozilla.org/de/firefox/addon/gitpod/)
34
34
2. Just hit the Gitpod button in the `README` file. Everything will spin up automatically.
35
35
3. When you're finished with your contribution just close the workspace.
36
36
@@ -63,7 +63,7 @@ $ npm run start:prod
63
63
64
64
- The API-Token is a static token, which gets set in the environment-variables as `APPROVED_TOKENS`.
65
65
- This token is used to authenticate an 'admin-App' against the API. The API-Token is used to generate **Bearer-Tokens**.
66
-
- For generating more than one token they can be passed to the environment-variables as a comma-seperated list.
66
+
- For generating more than one token they can be passed to the environment-variables as a comma-separated list.
67
67
68
68
## Swagger docs
69
69
@@ -88,7 +88,7 @@ $ npm run test:cov
88
88
## Logging
89
89
90
90
Logging can be turned on by settings an environment-variable `DEBUG=true`.
91
-
If this variables is not true or undefined no Logs will be made.
91
+
If this variable is not true or undefined no Logs will be made.
92
92
93
93
When set to `true` the App will Log every incoming request.
94
94
@@ -119,7 +119,7 @@ To use Authentication the token needs to be passed in the `token`-header of the
119
119
120
120
## Socials
121
121
122
-
Join our Discord community [here](http://discord.eddiehub.org/)
0 commit comments