Skip to content
Snippets Groups Projects
Commit 2f6dca99 authored by Torgrim's avatar Torgrim
Browse files

Resolved Typos in README.md

parent 338d558d
No related branches found
No related tags found
No related merge requests found
Pipeline #26777 failed
...@@ -16,7 +16,7 @@ This code was developed by: ...@@ -16,7 +16,7 @@ This code was developed by:
- Phrot Vedal [@BossTheModern](https://git.gvk.idi.ntnu.no/BossTheModern) - Phrot Vedal [@BossTheModern](https://git.gvk.idi.ntnu.no/BossTheModern)
## Features ## Features
- User Registration trough Firestore Auth - User Registration through Firestore Auth
- API Key Access - API Key Access
- GitLab CI/CD Integration - GitLab CI/CD Integration
- Docker Compose Containerization - Docker Compose Containerization
...@@ -34,17 +34,17 @@ This code was developed by: ...@@ -34,17 +34,17 @@ This code was developed by:
## API Reference / Documentation ## API Reference / Documentation
### Register as a user to retrieve API key: ### Register as a user to retrieve an API key:
```http ```http
POST /util/v1/user/register POST /util/v1/user/register
``` ```
| Content-Type | | Content-Type |
| :----------- | |:------------------------------------|
| `application/x-www-form-urlencoded` | | `application/x-www-form-urlencoded` |
| Key | Value: Type | Description | | Key | Value: Type | Description |
|:----------|:---------|:---------------------------| |:-----------|:------------|:----------------------------|
| `username` | `string` | **Required**. Your Username | | `username` | `string` | **Required**. Your Username |
| `email` | `string` | **Required**. Your Email | | `email` | `string` | **Required**. Your Email |
| `password` | `string` | **Required**. Your Password | | `password` | `string` | **Required**. Your Password |
...@@ -52,13 +52,13 @@ This code was developed by: ...@@ -52,13 +52,13 @@ This code was developed by:
#### Response: #### Response:
| Status Code | Content-Type | | Status Code | Content-Type |
|:-------------|:-------------------| |:--------------|:-------------------|
| `201 Created` | `application/json` | | `201 Created` | `application/json` |
```json ```json
{ {
"token": "your API key" "token": "your API key",
"userid" "your Unique User ID (UUID)" "userid": "your Unique User ID (UUID)"
} }
``` ```
...@@ -70,7 +70,7 @@ This code was developed by: ...@@ -70,7 +70,7 @@ This code was developed by:
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :---------------------- | |:----------|:---------|:------------------------|
| `ID` | `string` | **Required**. Your UUID | | `ID` | `string` | **Required**. Your UUID |
#### Response: #### Response:
...@@ -85,12 +85,12 @@ This code was developed by: ...@@ -85,12 +85,12 @@ This code was developed by:
``` ```
| Authorization | `Your UUID` | | Authorization | `Your UUID` |
| :------------ |:------------| |:--------------|:------------|
#### Response: #### Response:
| Status Code | Content-Type | | Status Code | Content-Type |
|:-------------|:-------------------| |:--------------|:-------------------|
| `201 Created` | `application/json` | | `201 Created` | `application/json` |
```json ```json
...@@ -99,14 +99,14 @@ This code was developed by: ...@@ -99,14 +99,14 @@ This code was developed by:
} }
``` ```
### Get New API key: (Old must be deleted first, only allowed one) ### Get a New API key: (Old must be deleted first, only allowed one)
```http ```http
DELETE /util/v1/key/?token={token} DELETE /util/v1/key/?token={token}
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :--------------------------| |:----------|:---------|:------------------------------------------|
| `token` | `string` | **Required**. Your API key, to be deleted | | `token` | `string` | **Required**. Your API key, to be deleted |
#### Response: #### Response:
...@@ -114,14 +114,14 @@ This code was developed by: ...@@ -114,14 +114,14 @@ This code was developed by:
| Status Code | `204 No Content` | | Status Code | `204 No Content` |
|:------------|:-----------------| |:------------|:-----------------|
### Check API Statuses: (Firestore, Dependant 3rd party API's, Version, Uptime) ### Check API Statuses: (Firestore, independent third party API, Version, Uptime)
```http ```http
GET /dashboards/v1/status?token={token} GET /dashboards/v1/status?token={token}
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :--------------------------| |:----------|:---------|:---------------------------|
| `token` | `string` | **Required**. Your API key | | `token` | `string` | **Required**. Your API key |
#### Response: #### Response:
...@@ -149,15 +149,15 @@ This code was developed by: ...@@ -149,15 +149,15 @@ This code was developed by:
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :--------------------------| |:----------|:---------|:---------------------------|
| `token` | `string` | **Required**. Your API key | | `token` | `string` | **Required**. Your API key |
##### Example POST Body: ##### Example POST-Body:
```json ```json
{ {
//Name of the Country, Can be omitted if "isocode" is provided. Case-Insensitive //The Name of the Country Can be omitted if "isocode" is provided. Case-Insensitive
"country": "Norway", "country": "Norway",
//Isocode for the Country, Can be omitted if "country" is provided. Case-Insensitive //Isocode for the Country Can be omitted if "country" is provided. Case-Insensitive
"isoCode": "NO", "isoCode": "NO",
// Map of Features to include when querying the dashboard endpoint, // Map of Features to include when querying the dashboard endpoint,
// features to not include can be omitted // features to not include can be omitted
...@@ -187,7 +187,7 @@ This code was developed by: ...@@ -187,7 +187,7 @@ This code was developed by:
#### Response: #### Response:
| Status Code | Content-Type | | Status Code | Content-Type |
|:-------------|:-------------------| |:--------------|:-------------------|
| `201 Created` | `application/json` | | `201 Created` | `application/json` |
```json ```json
...@@ -205,7 +205,7 @@ This code was developed by: ...@@ -205,7 +205,7 @@ This code was developed by:
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :--------------------------| |:----------|:---------|:---------------------------|
| `token` | `string` | **Required**. Your API key | | `token` | `string` | **Required**. Your API key |
...@@ -253,7 +253,7 @@ This code was developed by: ...@@ -253,7 +253,7 @@ This code was developed by:
] ]
}, },
"lastchange": "2024-04-18T22:19:48.651Z" "lastchange": "2024-04-18T22:19:48.651Z"
} },
... ...
] ]
``` ```
...@@ -265,7 +265,7 @@ This code was developed by: ...@@ -265,7 +265,7 @@ This code was developed by:
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :---------------------------------| |:----------|:---------|:----------------------------------|
| `ID` | `string` | **Required**. The Registration ID | | `ID` | `string` | **Required**. The Registration ID |
| `token` | `string` | **Required**. Your API key | | `token` | `string` | **Required**. Your API key |
...@@ -304,14 +304,14 @@ This code was developed by: ...@@ -304,14 +304,14 @@ This code was developed by:
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :---------------------------------| |:----------|:---------|:----------------------------------|
| `ID` | `string` | **Required**. The Registration ID | | `ID` | `string` | **Required**. The Registration ID |
| `token` | `string` | **Required**. Your API key | | `token` | `string` | **Required**. Your API key |
Specify features to update, Country/Isocode can not be updated, Specify features to update, Country/Isocode cannot be updated;
every features is not allowed to be false, atleast one feature must be true. every feature is not allowed to be false, at least one feature must be true.
##### Example POST Body: ##### Example POST-Body:
```json ```json
{ {
"features": { "features": {
...@@ -326,7 +326,7 @@ every features is not allowed to be false, atleast one feature must be true. ...@@ -326,7 +326,7 @@ every features is not allowed to be false, atleast one feature must be true.
#### Response: #### Response:
| Status Code | Content-Type | | Status Code | Content-Type |
|:-------------|:-------------------| |:---------------|:-------------------|
| `202 Accepted` | `application/json` | | `202 Accepted` | `application/json` |
```json ```json
...@@ -342,7 +342,7 @@ every features is not allowed to be false, atleast one feature must be true. ...@@ -342,7 +342,7 @@ every features is not allowed to be false, atleast one feature must be true.
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :---------------------------------| |:----------|:---------|:----------------------------------|
| `ID` | `string` | **Required**. The Registration ID | | `ID` | `string` | **Required**. The Registration ID |
| `token` | `string` | **Required**. Your API key | | `token` | `string` | **Required**. Your API key |
...@@ -358,7 +358,7 @@ every features is not allowed to be false, atleast one feature must be true. ...@@ -358,7 +358,7 @@ every features is not allowed to be false, atleast one feature must be true.
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :---------------------------------| |:----------|:---------|:----------------------------------|
| `ID` | `string` | **Required**. The Registration ID | | `ID` | `string` | **Required**. The Registration ID |
| `token` | `string` | **Required**. Your API key | | `token` | `string` | **Required**. Your API key |
...@@ -413,20 +413,20 @@ every features is not allowed to be false, atleast one feature must be true. ...@@ -413,20 +413,20 @@ every features is not allowed to be false, atleast one feature must be true.
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :---------------------------------| |:----------|:---------|:---------------------------|
| `token` | `string` | **Required**. Your API key | | `token` | `string` | **Required**. Your API key |
##### Example POST Body: ##### Example POST-Body:
```json ```json
{ {
"url": "Where to send the webhook payload", //Discord, webhook.site, etc... "url": "Where to send the webhook payload", //Discord, webhook.site, etc...
"country": "isocode for the country the webhook applies to, leave empty for all." "country": "isocode for the country the webhook applies to, leave empty for all.",
"event": ["List of events the webhook applies to."] "event": ["List of events the webhook applies to."]
} }
``` ```
##### List of Webhook Events: ##### List of Webhook Events:
| Event | Description | | Event | Description |
| :---------- | :--------------------------------------| |:-----------|:---------------------------------------|
| `INVOKE` | Envoke Webhook on retrival events. | | `INVOKE` | Envoke Webhook on retrival events. |
| `REGISTER` | Envoke Webhook on registration events. | | `REGISTER` | Envoke Webhook on registration events. |
| `CHANGE` | Envoke Webhook on update events. | | `CHANGE` | Envoke Webhook on update events. |
...@@ -452,7 +452,7 @@ every features is not allowed to be false, atleast one feature must be true. ...@@ -452,7 +452,7 @@ every features is not allowed to be false, atleast one feature must be true.
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :---------------------------------| |:----------|:---------|:---------------------------|
| `token` | `string` | **Required**. Your API key | | `token` | `string` | **Required**. Your API key |
#### Response: #### Response:
...@@ -492,7 +492,7 @@ every features is not allowed to be false, atleast one feature must be true. ...@@ -492,7 +492,7 @@ every features is not allowed to be false, atleast one feature must be true.
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :----------------------------| |:----------|:---------|:-----------------------------|
| `ID` | `string` | **Required**. The Webhook ID | | `ID` | `string` | **Required**. The Webhook ID |
| `token` | `string` | **Required**. Your API key | | `token` | `string` | **Required**. Your API key |
...@@ -521,7 +521,7 @@ every features is not allowed to be false, atleast one feature must be true. ...@@ -521,7 +521,7 @@ every features is not allowed to be false, atleast one feature must be true.
``` ```
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :------- | :----------------------------| |:----------|:---------|:-----------------------------|
| `ID` | `string` | **Required**. The Webhook ID | | `ID` | `string` | **Required**. The Webhook ID |
| `token` | `string` | **Required**. Your API key | | `token` | `string` | **Required**. Your API key |
...@@ -534,7 +534,7 @@ every features is not allowed to be false, atleast one feature must be true. ...@@ -534,7 +534,7 @@ every features is not allowed to be false, atleast one feature must be true.
To run this project, you will need to add the following environment variables to your .env file, or project environment. To run this project, you will need to add the following environment variables to your .env file, or project environment.
`PORT` - Port to run project on. `PORT` - Port to run the project on.
`FIREBASE_CREDENTIALS_FILE` - Path to your Firebase credentials file. `FIREBASE_CREDENTIALS_FILE` - Path to your Firebase credentials file.
...@@ -568,12 +568,12 @@ cd globeboard/Go/ ...@@ -568,12 +568,12 @@ cd globeboard/Go/
```bash ```bash
docker compose build docker compose build
``` ```
- #### Attached - Command line remains connected: - #### AttachedCommand line remains connected:
```bash ```bash
docker compose up globeboard docker compose up globeboard
``` ```
- #### Detached - Start the container in the background: - #### DetachedStart the container in the background:
```bash ```bash
docker compose up globeboard -d docker compose up globeboard -d
``` ```
...@@ -627,12 +627,12 @@ cd globeboard/Go/ ...@@ -627,12 +627,12 @@ cd globeboard/Go/
```bash ```bash
docker compose build docker compose build
``` ```
- #### Attached - Command line remains connected: - #### AttachedCommand line remains connected:
```bash ```bash
docker compose up globeboard-test docker compose up globeboard-test
``` ```
- #### Detached - Start the container in the background: - #### DetachedStart the container in the background:
```bash ```bash
docker compose up globeboard-test -d docker compose up globeboard-test -d
``` ```
...@@ -678,4 +678,6 @@ For support, email `torgrilt@stud.ntnu.no` or `torgrim.l.thorsen@gmail.com`. ...@@ -678,4 +678,6 @@ For support, email `torgrilt@stud.ntnu.no` or `torgrim.l.thorsen@gmail.com`.
This project is licensed under: This project is licensed under:
[![License: CC BY-NC-ND 4.0](https://img.shields.io/badge/License-CC_BY--NC--ND_4.0-green.svg)](https://creativecommons.org/licenses/by-nc-nd/4.0/) [![License: CC BY-NC-ND 4.0](https://img.shields.io/badge/License-CC_BY--NC--ND_4.0-green.svg)](https://creativecommons.org/licenses/by-nc-nd/4.0/)
You are free to download and use this code for educational, personal learning, or non-commercial purposes. And while we encourage these uses, please note that utilizing this project for commercial distribution, sales, or any form of monetization is not permitted. You are free to download and use this code for educational, personal learning, or non-commercial purposes.
\ No newline at end of file And while we encourage these uses, please note that using this project for commercial distribution,
sales, or any form of monetization is not permitted.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment