Site CAECOMP - Backend 🌐

AdonisJs | TypeScript

Sobre · Tecnologias utilizadas · Como usar

💭 Sobre

Backend do site do CAECOMP UFMT

👨‍💻 Tecnologias Utilizadas

• AdonisJs
• TypeScript
• Docker

⁉ Como usar

🤔 Pré-requisitos

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

• Node versão 14 ou superior.
• Ter em sua máquina o NPM ou Yarn para o gerenciamento dos pacotes da aplicação
• Ter o Docker para facilitar o setup do banco de dados
• 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/caecompufmt/site-caecomp-backend.git
  # Entre na pasta raiz da aplicação
  $ cd site-caecomp-backend

2. Instalar as dependências da aplicação

  $ yarn # ou npm install

3. Configurar as variáveis de ambiente

Crie um arquivo chamado de '.env' copiando as informações existentes no arquivo '.env.example'.

4. Iniciar docker da aplicação, este ja iniciará o mysql + aplicação

  # Comando para iniciar a aplicação em modo de desenvolvimento
  $ docker-compose up --build

5. Rode a migrations para subir as tabelas, é possível fazer isso usando:

  $ node ace migration:run
  # Ou use o script que limpa o banco e roda as migrations
  $ npm run db:clear

6. Use o phpmyadmin para visualizar e manipular o banco mysql.

  http://localhost:8084 # Use o user e senha do .env

---

^{Feito com 💙 por CAECOMP - UFMT}