Desabrigados

---

Índice

• Descrição
• Tecnologias utilizadas
• Funcionalidades
• Como executar o projeto (frontend)
• Como executar o projeto (Banco de dados)
• Contribuidores
• Como contribuir
• Licença

Descrição

O projeto desabrigados está sendo desenvolvido para auxiliar as vítimas das enchentes que assolaram o estado do Rio Grande do Sul em 2024. O principal objetivo é conectar as equipes de resgate com as pessoas que precisam ser resgatadas nas áreas atingidas pelas enchentes.

Tecnologias utilizadas

Funcionalidades

• Pedir resgate: O usuário irá preencher um formulário para chamar a equipe de resgate.
• Confirmar resgate: Após a equipe realizar o resgate, poderá confirmá-lo.
• Editar resgate: Permite que o usuário altere as informações de um pedido de resgate.
• Cancelar resgate: Permite que o usuário cancele um pedido de resgate.
• Excluir resgate: Permite que o usuário exclua um pedido de resgate.
• Cadastrar abrigo: Permite que o usuário cadastre um abrigo, informando o nome, capacidade, endereço entre outras informações.
• Consultar abrigos: Permite ao usuário consultar a lista de abrigos disponíveis em sua cidade, é possível filtrar por cidade e bairro;
• Editar abrigo: Permite que o usuário altere as informações de um abrigo.
• Excluir abrigo: Permite que o usuário exclua um abrigo.

Como executar o projeto (frontend)

1. Clone o repositório:

   git clone git@github.com:JoiaribeAlves/rescue.git

2. Entre no diretório:

   cd rescue

3. Instale as dependências:

   npm install

4. Inicie o servidor de desenvolvimento:

   npm run dev

5. Acesse pelo navegador: localhost:3000

Como executar o projeto (Banco de dados)

1. Crie um arquivo na raiz do projeto chamado .env

2. Copie e cole as variáveis contidas no arquivo .env.example

3. Na variável DATABASE_URL você deve definir a URL de conexão com o banco de dados. Por exemplo: postgresql://usuario:senha@localhost:5432/nome-do-banco-de-dados

4. Na variável VERIFICATION_CODE você deve definir um código de 6 dígitos, por exemplo: 123456. O código é utilizado nas telas de exclusão e edição para garantir que somente pessoas que saibam o código possam editar ou excluir dados.

5. Caso queira usar docker: (se não for usar, ignore esta etapa)

   docker-compose up -d

6. Execute as migrations:
   

   npx prisma db push && npx prisma generate

Se tudo ocorreu bem, você já pode realizar operações no banco de dados.

Contribuidores

Este projeto só foi possível graças ao trabalho dos contribuidores. Muito obrigado a todos que fazem isso acontecer.

Joiaribe	Caio	Guilherme

Como contribuir

Sua contribuição é bem-vinda! Se você tem interesse em ajudar a melhorar o app, siga os passos abaixo:

1. Faça um fork do repositório;
2. Crie uma branch para sua feature (git checkout -b feature/MinhaFeature);
3. Faça seus commits (git commit -m 'Adiciona uma nova feature');
4. Faça push para a branch (git push origin feature/MinhaFeature);
5. Abra um Pull Request.

Licença

Este projeto está disponibilizado sob licença MIT