Using nvm is advised.
Using yarn is required. Install it with npm like this:
npm install -g yarnClone the project:
git clone https://github.com/5-semesterprojekt/Backend.gitInstall packages:
cd backend
yarn installit is advised to use our frontend which can get cloned from and follow the guide that is written.
git clone https://github.com/5-semesterprojekt/Frontend.gitAfter that it is also advised to change the example file and rename them without example at the end, at the moment there 3 files that has to change.
This one is simple, go to the firebase console and create a new project. Then copy your own firestore config and paste it in the firebaseConfig-example.ts file and rename the file to firebaseConfig.ts
If you already have a gmail then you should just follow the intructions in the file and afterwards rename it to gmailSecrets.ts. If you dont own an gmail then create one and follow the instructions in the gmailSecrets-example.ts.
Just rename the one that is called "SECRET_KEY" to something secure, since this line is used store the user's token and could be hacked if compromised.
The backend can be started by running the start script:
yarn startYou can make your own website or use our frontend that we have developed along with this backend. You can get our frontend from here https://github.com/5-semesterprojekt/Frontend.git
Starts the api, you would now be able to make calls, look at the api doc
Runs all tests (see jest for more).
Formats the code according to the .prettierrc.
- Make a branch from
mainusing the suggested branch name from Shortcut. (i.e. feature/sc-{story number}/{feature-name}) - Commit until the feature is "complete"
- Run
yarn prettierso code is formatted correctly - Make pull request to
mainand request a review - Squash and merge when all requirements are met
It is HIGHLY advisable, that you don't branch off secondary branches. Only branch off main.
Feel free to customize and expand upon this documentation based on your specific contributions.
Create a new event by making a POST request to the following endpoint: Needs to be logged in/auth token
POST /events/:orgId/Request Body:
title (string, required): The title of the event.
start (date, required): The start date and time of the event in ISO format (e.g., "2019-12-17T03:24:00").
end (date, required): The end date and time of the event in ISO format.
description (string, optional): A description of the event.
Example:
{
"title": "some title",
"description": "some description",
"start": "2019-12-17T03:24:00",
"end": "2019-12-18T03:24:00"
}Response:
Status Code: 201 Created
Response Body: The created event object with an additional id field.
Retrieve all events for a specific organization by making a GET request to the following endpoint:
GET /events/:orgId/Response:
Status Code: 200 OK if the event is found.
Example
[
{
"title": "Event title",
"description": "something...",
"start": "2023-11-23T23:00:00.000Z",
"end": "2023-11-23T23:00:00.000Z",
"orgId": 123
}, ...
]Retrieve a specific event by its ID for a given organization by making a GET request to the following endpoint:
GET /events/:orgId/:idResponse:
Status Code: 200 OK if the event is found, 404 Not Found otherwise.
Update an existing event by making a PUT request to the following endpoint:
PUT /events/:orgId/:idRequest Body:
{
"title": "Updated Event Title",
"start": "2023-12-01T15:00:00",
"end": "2023-12-01T20:00:00",
"description": "Updated Event Description"
}Response:
Status Code: 200 OK
Response Body: The updated event object.
Delete a specific event by its ID for a given organization by making a DELETE request to the following endpoint:
DELETE /events/:orgId/:idResponse:
Status Code: 204 No Content if the event is deleted successfully, 404 Not Found otherwise.
Create a new user by making a POST request to the following endpoint:
POST /users/:orgId/Request Body:
{
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"password": "SecurePassword123!",
"repeatPassword": "SecurePassword123!"
}Response:
Status Code: 201 Created
Response Body: The created user object.
Authenticate a user by making a POST request to the following endpoint:
POST /users/:orgId/loginRequest Body:
{
"email": "john.doe@example.com",
"password": "SecurePassword123!"
}Response:
Status Code: 200 OK
Response Body: The authenticated user object.
Needs to be logged in/auth token
Retrieve all users for a specific organization by making a GET request to the following endpoint:
GET /users/:orgId/Response:
Status Code: 200 OK
Response Body: An array of user objects for the specified organization.
Needs to be logged in/auth token A jwt token must be present in the Authorization header. This token is received by logging in. Retrieve the user associated with the provided token by making a GET request to the following endpoint:
GET /users/:orgId/meResponse:
Status Code: 200 OK
Response Body: The user object.
Needs to be logged in/auth token
Retrieve a specific user by their ID for a given organization by making a GET request to the following endpoint:
GET /users/:orgId/:idResponse:
Status Code: 200 OK
Response Body: The user object.
Needs to be logged in/auth token
Update an existing user by making a PUT request to the following endpoint:
PUT /users/:orgId/:idRequest Body:
{
"firstName": "Updated John"
}Response:
Status Code: 200 OK
Response Body: The updated user object.
Needs to be logged in/auth token
Delete a specific user by their ID for a given organization by making a DELETE request to the following endpoint:
DELETE /users/:orgId/:idResponse:
Status Code: 204 No Content
Initiate the forgot password process by making a POST request to the following endpoint:
POST /users/:orgId/forgot-passwordRequest Body:
{
"email": "john.doe@example.com"
}Response:
Status Code: 200 OK
Response Body: An object with a message indicating that the email has been sent.
The error handling module in this application is designed to manage and respond to errors that may occur during the execution of API endpoints. It includes middleware functions for logging errors, responding with appropriate error messages, and handling invalid paths.
Custom errors, such as BaseError, are supported. They can be thrown with a specific status code and optional error details.
import { BaseError } from 'path-to-error-handler';
throw new BaseError('Custom error message', 404, { additionalInfo: 'details' });A BaseError should generally be thrown when an error is expected. i.e. when an entry doesn't exist in a database, then throw new BaseError('Error', 404); immediately.
The authentication middleware is designed to secure specific routes by ensuring that requests contain a valid JWT token in the Authorization header. If the token is valid, the middleware decodes it, extracts the user ID, and attaches it to the request object for further use in downstream middleware or route handlers.
The auth middleware function should be applied to routes or groups of routes that require authentication.
If the token is missing or invalid, the middleware responds with a 401 Unauthorized status code and the message "Please authenticate."
import { auth, CustomRequest } from 'path-to-authentication-middleware';
// ... Other middleware and route handling
// Apply authentication middleware to a route
app.get('/authenticated-route', auth, (req: CustomRequest, res) => {
// Access user ID from the decoded token
const userId = req.token;
// ... Other route handling logic
});