Skip to content

Back-end project using PostgreSQL and PrismaORM, with integration tests using Jest.

Notifications You must be signed in to change notification settings

yaratavares/API-RepoProvas

Repository files navigation

API - RepoProvas

Repository size GitHub last commit License

ProjetoObjetivoFuncionalidadesLayoutComo executarAutoraLicença

💻 Projeto

No RepoProvas qualquer pessoa pode procurar provas antigas de suas disciplinas e professores ou enviar provas antigas para ajudar os calouros.

Back-end projetado para um sistema de compartilhamento de provas entre estudantes.


✨ Objetivo

O principal objetivo do projeto foi aplicar o conceito das migrações e ORM e para isso utilizei o Prisma, usando um banco de dados relacional. Para um código mais limpo e organizado utilizei Layered Architecture (Routers, Controllers, Services e Repositories) e Typescript no desenvolvimento, para um código mais limpo e organizado.


⚙️ Funcionalidades

  • Os usuários tem acesso a plataforma web enviando:

    • email
    • senha
  • Dentro da aplicação os usuários com token de autenticação podem:

    • visualizar provas por disciplinas
    • visualizar provas por instrutores
    • filtrar provas por nome de disciplina ou instrutor
    • adicionar uma nova prova
    • clicar na prova e contabilizar o seu view

🚀 Como executar o projeto

Este projeto está dividido em duas partes:

  1. Backend (este repositório)
  2. Frontend 🧭

💡 O front-end não precisa que o back-end esteja rodando para funcionamento da aplicação.

Para ver as funcionalidades basta acessar o último deploy ou clicar no link da página.

Pré-requisitos

Para rodar a aplicação na sua máquina, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js e PostgreSQL. Além disto é bom ter um editor para trabalhar com o código como VSCode.

🎲 Rodando a aplicação web (Back-end)

# Clone este repositório
$ git clone [email protected]:yaratavares/API-RepoProvas.git
# Acesse a pasta do projeto no terminal/cmd e instale as dependências
$ npm insall
# Será necessário criar uma pasta .env como segue o modelo do arquivo .env.example
# Execute a aplicação em modo de desenvolvimento
$ npm run dev
# O servidor iniciará na porta:5000 - acesse http://localhost:5000

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Back-end

Veja o arquivo package.json

Front-end

badge react badge react

Veja o arquivo package.json


🧜‍♀️ Autora

foto

Yara Tavares 🚀

📝 Licença

Este projeto esta sobe a licença MIT.

About

Back-end project using PostgreSQL and PrismaORM, with integration tests using Jest.

Topics

Resources

Stars

Watchers

Forks

Languages