2024.1 POLLUX - Projeto EDRA

Sobre

O projeto EDRA têm como objetivo criar uma aplicação web que sirva para divulgação e também para o gerenciamento da equipe de competição EDRA da UnB - FGA, da qual, só os membros da equipe poderão ter acesso. Dessa forma, teremos dois grandes módulos de desenvolvimento.

Principais Recursos

• Divulgação: página com intuito de apresentar a equipe e seus integrantes, competições e informações essenciais para o processo seletivo.

• Gerência de calendário: página para gerenciar quadro Kanban de tarefas da equipe, e, também um calendário disponível para compromissos.

• Gerência de estoque: página para controlar as peças, com suas respectivas quantidades e status.

• Gerência de reuniões: página para adicionar atas e ter o controle de presença de reuniões.

• Gerência de documentos: página para administração de documentos linkados e acesso aos mesmos.

• Gerência de Financeiro: página para controle de entradas e saídas com suas respectivas descrições. Além do cálculo final com o saldo atualizado.

Documentação

Link para a documentação do projeto: MkDocs - Pollux 2024.1

Instruções para iniciar o site localmente (em ambientes Unix)

Dependências

• Node.js v20.13.1
• NPM (Node Package Manager)
• PostgreSQL
• Ruby
• Rails
• Docker

Passo a passo para iniciar o projeto

1. Clone o repositório:

   git clone https://github.com/FGA0138-MDS-Ajax/2024.1-POLLUX.git
   

   Caso seja necessário, entre na pasta do projeto

   cd 2024-1-POLLUX
   

2. Configuração do Banco de Dados:

   touch .env
   

   Coloque o nome do banco de dados, seu usuário e sua senha no arquivo .env

   cp .env /backend/
   

   sudo docker compose up -d
   

   cd backend/
   

   rails db:create
   

   rails db:migrate
   

3. Executar o projeto

   Para rodar o front-end da aplicação faça os seguintes comandos:

   cd view
   

   npm install
   

   npm run dev
   

   Em um novo terminal, navegue até a pasta backend para configurar o rails

   rails db:seed
   

   rails s
   

4. Para entrar na plataforma de gerenciamento

   Deve se acessar a logo da EDRA no canto superior esquerdo da tela e logar utilizando o seguinte login Matricula:

   000000000
   

   Senha:

   senha123
   

Instruções para executar os testes

1. Para fazer os testes unitarios

   Primeiramente você deve rodar o banco localmente, sem a utilização do docker crie seu usuário no postgres com o mesmo usuário e senha da sua .env

   cd /backend
   

   rails test
   

2. Para fazer os testes de integração com o Bruno

   Instale o Bruno.

   Com isso, escolha o diretório do repositório, vá em backend, docs e por fim, PolluxEndpoints. Altere o ambiente para "Dev", e as requisições estão prontas para serem testadas

Autores

Júlia Fortunato

Maurício Ferreira

Felipe Matheus

Maria Clara

João Ricardo

Caio Antônio

Felipe Brandim

Kauã Richard