https://github.com/krzysiou/mandatum-api

Api for Mandatum website. Written in typescript to hone my skills.
https://github.com/krzysiou/mandatum-api

rest-api ts typescript

Last synced: about 7 hours ago
JSON representation

Api for Mandatum website. Written in typescript to hone my skills.

• Host: GitHub
• URL: https://github.com/krzysiou/mandatum-api
• Owner: krzysiou
• Created: 2022-01-20T09:32:33.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-22T13:46:21.000Z (over 2 years ago)
• Last Synced: 2023-03-02T07:20:21.395Z (over 1 year ago)
• Topics: rest-api, ts, typescript
• Language: TypeScript
• Homepage:
• Size: 109 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Mandatum-api

This is a ```Node.js RestAPI``` developed for my [Mandatum](https://github.com/krzysiou/Mandatum) website. It contains endpoints which allow front-end to send and request data. It got hot-reload feature using nodemon. To host server on your computer simply type ```npm install``` and follow it by ```nodemon index.js```

## Technologies

- Express

- Joi

- Prisma

- Postgresql

- JWT

## Overview

The most important file on the whole server is [index.js](./source/server.ts), it contains all endpoints corresponding to given functions that will be called upon request hitting the endpoint.

I designed a few controllers located in [this folder](./source/controllers) they contain methods which operate on set of values and manage the data accordingly. Make sure to provide your working directory with ```.env file``` containing key ```ACCESS_TOKEN_SECRET=``` and give it a custom value of your choice. It is used to generate and sign JWT tokens. It should also contain ```PORT=``` and ```DATABASE_URL=``` which will allow you to start the backend with a database.

## Division

I divided the backend section into three parts ```Authorization Users and Validation```.

### Authorization [file](./source/authorization/checkAuth.ts)

This file contains method that authorizes every secured endpoint meaning that it guards contents of the page that shouldn't be operatable by users that are not logged in. It checks if JWT token was passed in a request header and verifies it by decoding the token using ```ACCESS_TOKEN_SECRET```

In case of successful authorization, user is allowed to access the endpoint. In any other case endpoint is blocked and error is sent to front-end.

### Users [file](./source/controllers/users.ts)

It consists of list of methods that allow server to fully operate on user data.

### Validation [file](./source/validation.ts)

This file is based on ```Joi's``` validation. It consists of schemas that are used to validate if values of keys of passed objects got valid properties.

The validation throws error if any of the properties isn't valid.

### Database [file](./prisma/schema.prisma)

A file containing schemas for the Prisma ORM that describe how databases and relations should be created.