Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rhuam authored May 6, 2024
1 parent be5e733 commit f464f41
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# README para o Frontend do App de Ajuda em Enchentes

Este projeto é o frontend de um aplicativo destinado a auxiliar na organização e distribuição de suprimentos, além de coordenar voluntários durante os alagamentos no Rio Grande do Sul. A aplicação visa conectar pessoas afetadas pelas enchentes com recursos essenciais e voluntários dispostos a ajudar.

## Sobre o Projeto

O objetivo deste aplicativo é facilitar uma resposta rápida e eficiente em situações de emergência causadas por enchentes, promovendo a colaboração e o apoio mútuo entre a comunidade e organizações de ajuda.

## Tecnologias Utilizadas

Este frontend foi desenvolvido utilizando as seguintes tecnologias:

- **React**: Uma biblioteca JavaScript para construir interfaces de usuário.

## Funcionalidades

O app inclui as seguintes funcionalidades:

- [x]**Cadastro de Itens de suprimentos**: Permite que voluntários se inscrevam para ajudar.
- [x]**Busca de abrigos**: Gerencia a logística de distribuição de suprimentos para as áreas mais necessitadas.
- [x]**Alteração de necessidades de abrigos**: Exibe um mapa das áreas afetadas e pontos de coleta de suprimentos.
- [ ]**Cadastro de abrigos**: Facilita a comunicação entre os gestores de crise, voluntários e beneficiados.
- [ ]**Cadastro de usuários**: Facilita a comunicação entre os gestores de crise, voluntários e beneficiados.

Para executar o frontend do aplicativo em seu ambiente local, siga os passos abaixo:

1. Clone o repositório:
```
git clone https://github.com/seuusuario/projeto-enchentes-frontend.git
```
2. Entre no diretório do projeto:
```
cd projeto-enchentes-frontend
```
3. Instale as dependências:
```
npm install
```
4. Inicie o servidor de desenvolvimento:
```
npm start
```
O app estará disponível em `http://localhost:3000`.

## Contribuindo

Contribuições são muito bem-vindas! Se você tem interesse em ajudar a melhorar o app, por favor:

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 -am 'Adicionando 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á sob a licença MIT. Veja o arquivo `LICENSE` para mais detalhes.

## Contato

Para mais informações, entre em contato com [seu nome] pelo e-mail [seu email].

---

Agradecemos o seu interesse e apoio. Juntos, podemos fazer uma diferença significativa para as vítimas das enchentes no Rio Grande do Sul!

0 comments on commit f464f41

Please sign in to comment.