https://github.com/fellipeutaka/yagami

💼 API for managing homeworks
https://github.com/fellipeutaka/yagami

docker fastify jwt postgresql prisma swagger typescript vitest zod

Last synced: 25 days ago
JSON representation

💼 API for managing homeworks

• Host: GitHub
• URL: https://github.com/fellipeutaka/yagami
• Owner: fellipeutaka
• Created: 2024-05-22T04:40:42.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-05-28T18:28:10.000Z (7 months ago)
• Last Synced: 2024-10-15T03:52:38.045Z (2 months ago)
• Topics: docker, fastify, jwt, postgresql, prisma, swagger, typescript, vitest, zod
• Language: TypeScript
• Homepage: https://yagami.apidocumentation.com
• Size: 292 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Run in Insomnia}](https://insomnia.rest/images/run.svg)](https://insomnia.rest/run/?label=Yagami&uri=https%3A%2F%2Fraw.githubusercontent.com%2Ffellipeutaka%2Fyagami%2Fmain%2F.github%2Fassets%2Finsomnia.json)

## FRs (Functional requirements)

- [x] It should be possible to register;

- [x] It should be possible to authenticate;

- [x] It should be possible to obtain the profile of a logged in user;

- [x] It should be possible to list all homeworks;

- [x] It should be possible to add a new homework;

- [x] It should be possible to edit a homework;

- [x] It should be possible to delete a homework;

- [x] It should be possible to mark a homework as completed;

## BRs (Business Rules)

- [x] The user must not be able to register with a duplicate email;

## NFRs (Non-Functional Requirements)

- [x] The user's password must be encrypted;

- [x] Application data must be persisted in a PostgreSQL database;

- [x] All data lists must be paginated using cursor-based pagination;

- [x] The user must be identified by a [JWT (JSON Web Token)](https://jwt.io/introduction);