README.md

📚 Quiz App Backend

Node.js | AdonisJS

Sobre · Tecnologias utilizadas · Como usar · Material de apoio · Como contribuir · Licença

💭 Sobre

Uma pequena aplicação de quiz usando a biblioteca React.

👨‍💻 Tecnologias Utilizadas

• Node com AdonisJs
• TypeScript para tipagem do projeto como um todo.

⁉ Como usar

🤔 Pré-requisitos

Para conseguir utilizar a aplicação sem nenhum problema é necessário ter:

• O Node.js instalado no computador para a execução do app
• Ter em sua máquina o NPM ou Yarn para o gerenciamento dos pacotes da aplicação
• E não menos importante, o Git para clonar o repositório em seu computador

📝 Passo a passo

Primeiro clone o repositório em seu computador, por meio do terminal utilizando o comando:

1. Clonando o repositório

  # Clone o repositório
  $ git clone https://github.com/Gabrielpatrola/growth-quiz-backend
  # Entre na pasta raiz da aplicação
  $ cd growth-quiz-backend

2. Crie um arquivo .env

Copie o arquivo env.example e crie um novo arquivo chamado .env e mude as variáveis caso necessário

3. Instalando as dependências do projeto

  $ yarn # ou npm install

4. Inicie o docker

  # Inicie o docker
  $ docker-compose up -d

5. Rode as migrations e seeders

  # Comando para rodar as migrações
  $ node ace migration:run 
  # Comando para rodar o seeder
  $ node ace db:seed

6. Inicie a aplicação

  # Comando para rodar as migrações
  $ yarn dev # ou npm run dev

Após seguir esses passos é possível acessar a aplicação em http://localhost:3333

📚 Material de Apoio

• Postman com as requisições

💪 Como contribuir

Basta criar um fork do projeto, realizar as modificações que achar necessário e depois fazer um Pull Request. Toda ajuda é bem vinda, caso veja algum erro, não hesite em contribuir com o projeto!

📃 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---

^{Feito com 💙 por Gabriel Patrola}