Skip to content

Commit 851b9b8

Browse files
committed
Altera o README com uma estrutura parecida com o que tem no projeto de backend
1 parent e17170f commit 851b9b8

File tree

1 file changed

+36
-21
lines changed

1 file changed

+36
-21
lines changed

README.md

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,70 @@
1-
# README
1+
# Frontend da aplicação de Ajuda em Enchentes
22

33
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.
44

5-
## Acesso à Aplicação
5+
## 🌎 Acesso à Aplicação
66

77
[SOS Rio Grande do Sul](https://sos-rs.com/)
88
[Discord](https://discord.gg/eJTuannsd6)
99

10-
## Sobre o Projeto
10+
## 📓 Sobre o Projeto
1111

1212
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.
1313

14-
## Tecnologias Utilizadas
14+
## 🛠 Tecnologias Utilizadas
1515

1616
Este frontend foi desenvolvido utilizando as seguintes tecnologias:
1717

18+
- [**Node.js**](https://nodejs.org): Ambiente de execução para JavaScript.
1819
- [**React**](https://react.dev/): Uma biblioteca JavaScript para construir interfaces de usuário.
1920
- [**Vite**](https://vitejs.dev/guide/): Uma ferramenta de build com servidor de desenvolvimento.
2021
- [**Tailwind CSS**](https://tailwindcss.com/docs/installation): Framework CSS baseado em classes utilitárias.
2122
- [**shadcn/ui**](https://ui.shadcn.com/docs): Coleção de componentes reutilizáveis, baseado em Tailwind.
2223

23-
Para executar o frontend do aplicativo em seu ambiente local, siga os passos abaixo:
24+
**Nota**: A versão mínima do Node.js suportada pelo projeto é a versão `18.19.1`, você pode usar essa ou uma versão superior.
2425

25-
1. Clone o repositório:
26-
```
27-
git clone https://github.com/SOS-RS/frontend
28-
```
29-
2. Entre no diretório do projeto:
30-
```
31-
cd frontend
26+
## 🤝 Contribuindo
27+
28+
Contribuições são muito bem-vindas! Se você tem interesse em ajudar a melhorar o app, por favor:
29+
30+
1. Faça um fork do repositório.
31+
2. Crie uma branch para sua feature (`git checkout -b feature/MinhaFeature`).
32+
3. Faça seus commits (`git commit -m 'Adicionando uma nova feature'`).
33+
4. Faça push para a branch (`git push origin feature/MinhaFeature`).
34+
5. Abra um Pull Request.
35+
36+
37+
## 🚀 Configuração Inicial Local
38+
39+
**Note**: Para executar esse projeto local, o projeto de [backend](https://github.com/SOS-RS/backend) deve estar rodando no seu ambiente local.
40+
41+
1. Faça um fork do repositório para o seu usuário (uma boa ideia é usar um nome mais descritivo do que `frontend`, como `sos-rs-frontend`).
42+
43+
2. Clone o repositório (troque `<seuusuario>` na url abaixo pelo seu usuário) caso tenha dado um nome diferente para seu repositório troque o nome do repositório:
44+
```bash
45+
git clone https://github.com/<seuusuario>/sos-rs-frontend.git
3246
```
47+
3348
3. Instale as dependências:
34-
```
49+
```bash
3550
npm install
3651
```
52+
3753
4. Inicie o servidor de desenvolvimento:
3854
```
3955
npm run dev
4056
```
4157
O app estará disponível em `http://localhost:5173`.
4258

43-
## Contribuindo
59+
## 📋 Licença
4460

45-
Contribuições são muito bem-vindas! Se você tem interesse em ajudar a melhorar o app, por favor:
61+
Este código está licenciado usando a
62+
[licença MIT](./LICENSE).
4663

47-
1. Faça um fork do repositório.
48-
2. Crie uma branch para sua feature (`git checkout -b feature/MinhaFeature`).
49-
3. Faça seus commits (`git commit -m 'Adicionando uma nova feature'`).
50-
4. Faça push para a branch (`git push origin feature/MinhaFeature`).
51-
5. Abra um Pull Request.
64+
## ❤️ Contribuidores
5265

53-
---
66+
Os contribuidores são voluntários, e podem ser encontrados
67+
[na página de contribuidores](https://github.com/SOS-RS/frontend/graphs/contributors).
5468

69+
---
5570
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 commit comments

Comments
 (0)