Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boxy-smd/deck-api
🃏 Back-end da aplicação Deck, um repositório de trabalhos realizados por alunos do curso de Sistemas e Mídias Digitais da Universidade Federal do Ceará.
https://github.com/boxy-smd/deck-api
fastify nodejs smd typescript ufc university
Last synced: about 1 month ago
JSON representation
🃏 Back-end da aplicação Deck, um repositório de trabalhos realizados por alunos do curso de Sistemas e Mídias Digitais da Universidade Federal do Ceará.
- Host: GitHub
- URL: https://github.com/boxy-smd/deck-api
- Owner: boxy-smd
- Created: 2024-07-31T21:55:17.000Z (5 months ago)
- Default Branch: production
- Last Pushed: 2024-10-16T11:04:46.000Z (2 months ago)
- Last Synced: 2024-10-17T23:28:35.231Z (2 months ago)
- Topics: fastify, nodejs, smd, typescript, ufc, university
- Language: TypeScript
- Homepage: https://deck-api.onrender.com
- Size: 851 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Deck API
## :bookmark: **Sumário**
- [Sobre o Projeto](#black_joker-sobre-o-projeto)
- [Rotas do Projeto](#file_folder-rotas-do-projeto)
- [Tecnologias](#wrench-tecnologias)
- [Construção da API](#construção-da-api)
- [Testes](#testes)
- [IDE, Versionamento e Deploy](#ide-versionamento-e-deploy)
- [Configurações e Instalação](#rocket-configurações-e-instalação)
- [Requisitos](#requisitos)
- [Licença](#balance_scale-licença)
## :black_joker: **Sobre o Projeto**
Deck é uma aplicação que servirá como repositório de trabalhos realizados por alunos do curso de Sistemas e Mídias Digitais da Universidade Federal do Ceará.
## :file_folder: Rotas do Projeto
## Estudantes
> - **`POST` /profile-images/:username** _Realiza o upload da imagem de perfil do estudante._
> - **`POST` /students** _Regista um estudante._
> - **`POST` /sessions** _Autentica um estudante._
> - **`GET` /students** _Lista os estudantes._
> - **`GET` /profiles** _Obtém o perfil de um estudante._
> - **`PUT` /profiles** _Edita o perfil de um estudante._
## Projetos
> - **`GET` /projects** _Lista os projetos._
> - **`GET` /projects/:id** _Obtém os detlhes de um projeto._
> - **`POST` /projects** _Publica um projeto._
> - **`PUT` /projects/:id** _Edita um projeto._
> - **`DELETE` /projects** _Exclui um projeto._
> - **`POST` /banners/:projectId** _Realiza o upload do banner do projeto._
### Tags
> - **`GET` /professors** _Lista os professores._
> - **`GET` /subjects** _Lista as disciplinas._
> - **`GET` /trails** _Lista as trilhas._
### Comentários
> - **`POST` /projects/:id/comments** _Comenta em um projeto._
Encontre a documentação completa [aqui](https://deck-api.onrender.com/docs).
## :wrench: **Tecnologias**
Tecnologias utilizadas no projeto.
### **Construção da API**
- [TypeScript](https://www.typescriptlang.org)
- [Fastify](https://fastify.dev)
- [@fastify/jwt](https://github.com/fastify/fastify-jwt)
- [@fastify/cookie](https://github.com/fastify/fastify-cookie)
- [@fastify/swagger](https://github.com/fastify/fastify-swagger)
- [@fastify/swagger-ui](https://github.com/fastify/fastify-swagger-ui)
- [Node.js](https://nodejs.org/en)
- [Zod](https://zod.dev)
- [BCrypt](https://www.npmjs.com/package/bcrypt)
### **Banco de Dados**
- [Prisma](https://www.prisma.io/)
- [Docker](https://www.docker.com/)
- [PostgreSQL](https://www.postgresql.org/)
- [Firebase Storage](https://firebase.google.com/docs/storage)
### **Testes**
- [Vitest](https://vitest.dev)
- [Supertest](https://www.npmjs.com/package/supertest)
### **IDE, Versionamento e Deploy**
- [Visual Studio Code](https://code.visualstudio.com)
- [Git](https://git-scm.com)
- [GitHub](https://github.com)
## :rocket: **Configurações e Instalação**
### Requisitos
- [Node](https://nodejs.org/) e [pnpm](https://pnpm.io/pt/).
- [Docker](https://www.docker.com/).
```sh
# Caso não tenha o pnpm, execute:
npm install -g pnpm
```
Recomendo que veja a [documentação de configuração do Fastify](https://fastify.dev/docs/latest/Reference/).
```sh
# Clonando o projeto
git clone https://github.com/boxy-smd/deck-api.git
# Instalando as dependências
pnpm install
# Criando o container do banco de dados:
docker compose up
# Fazendo as migrações para o banco de dados:
pnpm db:migrate
# Criar arquivo .env com base no .env.example e preencher os campos necessários
NODE_ENV=
JWT_SECRET=
PORT=
DATABASE_URL=
FIREBASE_API_KEY=
FIREBASE_APP_ID=
FIREBASE_AUTH_DOMAIN=
FIREBASE_MESSAGING_SENDER_ID=
FIREBASE_PROJECT_ID=
FIREBASE_STORAGE_BUCKET=
# Popular o banco de dados com as informações necessárias do sistema
pnpm db:seed
# Rodar o servidor em desenvolvimento
pnpm start:dev
# Iniciar testes gerais
pnpm test
# Iniciar testes unitários
pnpm test:unit
# Iniciar testes E2E
pnpm test:e2e
# Compilar e minificar para produção
pnpm build
# Rodar o servidor em produção
pnpm start
```
---
Feito com 💙 e ☕ por Boxy.