|
1 | | -# README |
| 1 | +# Frontend da aplicação de Ajuda em Enchentes |
2 | 2 |
|
3 | 3 | 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. |
4 | 4 |
|
5 | | -## Acesso à Aplicação |
| 5 | +## 🌎 Acesso à Aplicação |
6 | 6 |
|
7 | 7 | [SOS Rio Grande do Sul](https://sos-rs.com/) |
8 | 8 | [Discord](https://discord.gg/eJTuannsd6) |
9 | 9 |
|
10 | | -## Sobre o Projeto |
| 10 | +## 📓 Sobre o Projeto |
11 | 11 |
|
12 | 12 | 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. |
13 | 13 |
|
14 | | -## Tecnologias Utilizadas |
| 14 | +## 🛠 Tecnologias Utilizadas |
15 | 15 |
|
16 | 16 | Este frontend foi desenvolvido utilizando as seguintes tecnologias: |
17 | 17 |
|
| 18 | +- [**Node.js**](https://nodejs.org): Ambiente de execução para JavaScript. |
18 | 19 | - [**React**](https://react.dev/): Uma biblioteca JavaScript para construir interfaces de usuário. |
19 | 20 | - [**Vite**](https://vitejs.dev/guide/): Uma ferramenta de build com servidor de desenvolvimento. |
20 | 21 | - [**Tailwind CSS**](https://tailwindcss.com/docs/installation): Framework CSS baseado em classes utilitárias. |
21 | 22 | - [**shadcn/ui**](https://ui.shadcn.com/docs): Coleção de componentes reutilizáveis, baseado em Tailwind. |
22 | 23 |
|
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. |
24 | 25 |
|
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 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 |
32 | 46 | ``` |
| 47 | + |
33 | 48 | 3. Instale as dependências: |
34 | | - ``` |
| 49 | + ```bash |
35 | 50 | npm install |
36 | 51 | ``` |
| 52 | + |
37 | 53 | 4. Inicie o servidor de desenvolvimento: |
38 | 54 | ``` |
39 | 55 | npm run dev |
40 | 56 | ``` |
41 | 57 | O app estará disponível em `http://localhost:5173`. |
42 | 58 |
|
43 | | -## Contribuindo |
| 59 | +## 📋 Licença |
44 | 60 |
|
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). |
46 | 63 |
|
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 |
52 | 65 |
|
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). |
54 | 68 |
|
| 69 | +--- |
55 | 70 | 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