/exams-app-api

O Exam App é uma API REST que poderá servir a uma aplicação de provas online.

Primary LanguageTypeScript

Exam App

Feito por Daniel

Exam App - Back-end 🚪

Exam App ? 🤔

O Exam App é uma API REST que poderá servir a uma aplicação de provas online.

Funcionalidades ✔️

  • - Provas (GET, POST, PUT, DELETE)
  • - Questões da prova (GET, POST, PUT, DELETE)
  • - Ao listar as questões de prova (GET /questions), irá retornar as questões em ordem randomizadas, tanto as opções de resposta (options), como também as ordens das questões para que cada prova possua uma configuração única e dificultemos a vida de quem cola 😎

Tecnologias utilizadas 💻

Principais Packages 📦

Aprendizados do projeto 🔥

Como executar o projeto 🚀

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:

  • Git
  • Node.js.
  • Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando o Backend (servidor)

# Clone este repositório
$ git clone https://github.com/danielotaviano/exams-app-api

# Acesse a pasta do projeto no terminal/cmd
$ cd exams-app-api

# Instale as dependências
## Com Yarn
$ yarn

## Com Npm
$ npm install

# Configure sua .env
## Junto do projeto, vem um arquivo .env.example
## Lá vai está descritas todas as variaveis ambientes que terá que ter no seu .env!
## Obs: Certifique-se que seu banco de dados está em pé antes de rodar a aplicação

# Execute a aplicação em modo de desenvolvimento
## Yarn
$ yarn start:dev

## Npm
$ npm run start:dev

# O servidor inciará na porta configurada no .env
# Sua URL base será http://localhost:PORT

Rotas e Endpoints 👾

Testes 🧪

Statements Branches Functions Lines
Statements Branches Functions Lines

Demo Live 🔴

URL Base: https://exam-app-demo-live.herokuapp.com

O Servidor e o Database estão hospedados gratuitamente nos respectivos serviços:

Obs: Tanto o banco de dados como a api está hospedados em serviços gratuitos e pode sofrer instabilidades.

Qualquer problema, pode falar comigo por estes meios:

💪 Como contribuir no projeto

  1. Faça um fork do projeto.
  2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
  3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
  4. Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub