/RepoProvas-API

Primary LanguageTypeScript

RepoProvas-API

Projeto RepoProvas

šŸ“‹ DescriĆ§Ć£o

Back-end da aplicaĆ§Ć£o RepoProvas, que tem por finalidade a criaĆ§Ć£o de um repositĆ³rio de provas e a organizaĆ§Ć£o destas por periodos, disciplinas e professores.

Feramentas e tecnologias utilizadas: Heroku, PostgresSQL, TypeScript, Prisma, Node JS, EXPRESS, JWT

šŸ’» Tecnologias e Conceitos

  • REST APIs
  • JWTs/bcrypt
  • Node.js
  • TypeScript
  • Postgres SQL
  • Prisma

šŸš€ Rotas

POST /sign-up
    - Rota para cadastrar um novo usuƔrio
    - headers: {}
    - body:{
        "email": "Lorem ipsum",
        "password": "1234",
        "passwordConfirmation": "1234"
}
POST /sign-in
    - Rota para fazer login
    - headers: {}
    - body: {
    "email": "lorem@gmail.com",
    "senha": "1234"
    }
POST /tests (autenticada)
    - Rota para inserir novo registro de prova
    - headers: { "Authorization": "Bearer $token" }
    - body: {
    "nome": "Nome da prova",
    "pdfUrl": "https://loremisum..."
    "categorieId": 1,
    "disciplineId": 1,
    "teacherId": 1    
    }
GET /tests/disciplines (autenticada)
    - Rota para listar todas as provas, sendo o agrupamentopor perĆ­odo e por disciplinas
    - headers: { "Authorization": "Bearer $token" }
    - body: {}
GET /tests/teachers (autenticada)
    - Rota para listar todas as provas, sendo o agrupamentopor perĆ­odo e por professor
    - headers: { "Authorization": "Bearer $token" }
    - body: {}

šŸ Rodando a aplicaĆ§Ć£o

Primeiro, faƧa o clone desse repositĆ³rio na sua maquina:

https://github.com/LucasBrandaoGomes/RepoProvas-API.git

Depois, dentro da pasta, rode o seguinte comando para instalar as dependencias.

npm install

Finalizado o processo, Ć© sĆ³ inicializar o servidor

npm start