Skip to content

Latest commit

 

History

History
268 lines (214 loc) · 9.64 KB

README.md

File metadata and controls

268 lines (214 loc) · 9.64 KB
Raw

2022-2-Squad04 - FGAtlas

Contributors Forks Issues maintainability MIT License


Logo

FGAtlas

Um incrível mapa para se localizar na FGA!
Reportar Bug · Recomendar Feature

Conteúdo
  1. Sobre o projeto
  2. Pre-Requisitos
  3. Como rodar
  4. Backlog do produto
  5. Desenvolvedores
  6. Como contribuir
  7. Licença

🌎 Sobre o projeto

FGAtlas é um projeto web que fornece a localização dos prédios e salas da FGA, a fim de auxiliar calouros e veteranos a encontrarem os locais onde terão suas aulas. A ideia surgiu após a equipe realizar, em grupos da faculdade, uma pesquisa via forms na qual questionava os estudantes qual era a maior dificuldade dos mesmos no campus, a grande parte das respostas foram direcionadas à questões envolvendo localização. Segue algumas telas da aplicação:


🔨 Tecnologias

Tecnologias utilizadas neste repositório:

Tecnologias

❗ Pré-requisitos

Antes de começar, você precisa ter instalado as seguintes ferramentas:

📈 Como rodar

Para executar o backend:

  1. Clone o repositório
git clone https://github.com/fga-eps-mds/2022-2-FGAtlas.git
  1. Instale todas as dependências do repositório com:
npm install
  1. Inicie a aplicação com o comando:
npm run start

Para executar o frontend:

  1. Clone o repositório
git clone https://github.com/fga-eps-mds/2022-2-FGAtlas.git
  1. Vá para a pasta do vite
cd ./vite-project
  1. Instale todas as dependências com:
npm install
  1. Execute no terminal:
npm run dev

Para executar os testes do backend:

  1. Clone o repositório
git clone https://github.com/fga-eps-mds/2022-2-FGAtlas.git
  1. Crie um novo banco de dados para testes com:
dbcreate fgatlasdb_test
  1. Instale todas as dependências do repositório com:
npm install
  1. Inicie os testes com:
npm run test

Para executar os testes do frontend:

  1. Clone o repositório
git clone https://github.com/fga-eps-mds/2022-2-FGAtlas.git
  1. Vá para a pasta do vite
cd ./vite-project
  1. Instale todas as dependências com:
npm install
  1. Execute no terminal:
npx cypress open

📙 Backlog do produto

Para visualizar o BackLog do produto, acesse: BackLog

❤️ Comunidade

Para conseguir desenvolver o projeto FGAtlas de maneira produtiva e dinâmica utilizamos o Whatsapp para uma comunicação mais rápida e para realizar as reuniões, como dailys e reuniões semanais, e definição de Sprints e Issues utilizamos o Discord. Além disso, para organização do código e comentar detalhes importantes utilizamos as próprias Issues. Para uma melhor organização das issues e para uma metrificação mais detalhada das contribuições utilizamos o ZenHub.

❓ Como contribuir

Para contribuir com o projeto leia o Guia de Contribuição e para saber como se deve comportar para um bom andamento do projeto, leia nosso Código de Conduta

😄 Desenvolvedores

Carla Clementino
Debora Caires
João Pedro
Kauã Vinícius ✠
Paulo Renato
Rafael Brito
Sabrina Berno

Autoavaliação do grupo

Foi feita uma autoavalição dos membros na Release 1 em relação a contribuição com o projeto, assim como na Release 2. É possível observar nos documentos que o grupo teve um desempenho bem equilibrado, o que contribuiu para um bom trabalho em equipe.

💀 Post Mortem

O grupo fez um Post Mortem para descrever um pouco da experiência de cada membro dentro da matéria e durante o desenvolvimento da aplicação. O documento também é voltado para auxiliar futuros alunos da matéria de MDS.

🗿 Autores

Kauã Vinícius e Rafael Bosi

💨 Licença

Distributed under the MIT License. See LICENSE for more information.