-
Notifications
You must be signed in to change notification settings - Fork 322
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Altera o README com uma estrutura parecida com o que tem no projeto d…
…e backend
- Loading branch information
Showing
1 changed file
with
36 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,55 +1,70 @@ | ||
# README | ||
# Frontend da aplicação 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. | ||
|
||
## Acesso à Aplicação | ||
## 🌎 Acesso à Aplicação | ||
|
||
[SOS Rio Grande do Sul](https://sos-rs.com/) | ||
[Discord](https://discord.gg/eJTuannsd6) | ||
|
||
## Sobre o Projeto | ||
## 📓 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 | ||
## 🛠 Tecnologias Utilizadas | ||
|
||
Este frontend foi desenvolvido utilizando as seguintes tecnologias: | ||
|
||
- [**Node.js**](https://nodejs.org): Ambiente de execução para JavaScript. | ||
- [**React**](https://react.dev/): Uma biblioteca JavaScript para construir interfaces de usuário. | ||
- [**Vite**](https://vitejs.dev/guide/): Uma ferramenta de build com servidor de desenvolvimento. | ||
- [**Tailwind CSS**](https://tailwindcss.com/docs/installation): Framework CSS baseado em classes utilitárias. | ||
- [**shadcn/ui**](https://ui.shadcn.com/docs): Coleção de componentes reutilizáveis, baseado em Tailwind. | ||
|
||
Para executar o frontend do aplicativo em seu ambiente local, siga os passos abaixo: | ||
**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. | ||
|
||
1. Clone o repositório: | ||
``` | ||
git clone https://github.com/SOS-RS/frontend | ||
``` | ||
2. Entre no diretório do projeto: | ||
``` | ||
cd frontend | ||
## 🤝 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 -m 'Adicionando uma nova feature'`). | ||
4. Faça push para a branch (`git push origin feature/MinhaFeature`). | ||
5. Abra um Pull Request. | ||
|
||
|
||
## 🚀 Configuração Inicial Local | ||
|
||
**Note**: Para executar esse projeto local, o projeto de [backend](https://github.com/SOS-RS/backend) deve estar rodando local. | ||
|
||
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`). | ||
|
||
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: | ||
```bash | ||
git clone https://github.com/<seuusuario>/sos-rs-frontend.git | ||
``` | ||
|
||
3. Instale as dependências: | ||
``` | ||
```bash | ||
npm install | ||
``` | ||
|
||
4. Inicie o servidor de desenvolvimento: | ||
``` | ||
npm run dev | ||
``` | ||
O app estará disponível em `http://localhost:5173`. | ||
|
||
## Contribuindo | ||
## 📋 Licença | ||
|
||
Contribuições são muito bem-vindas! Se você tem interesse em ajudar a melhorar o app, por favor: | ||
Este código está licenciado usando a | ||
[licença MIT](./LICENSE). | ||
|
||
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 'Adicionando uma nova feature'`). | ||
4. Faça push para a branch (`git push origin feature/MinhaFeature`). | ||
5. Abra um Pull Request. | ||
## ❤️ Contribuidores | ||
|
||
--- | ||
Os contribuidores são voluntários, e podem ser encontrados | ||
[na página de contribuidores](https://github.com/SOS-RS/frontend/graphs/contributors). | ||
|
||
--- | ||
Agradecemos o seu interesse e apoio. Juntos, podemos fazer uma diferença significativa para as vítimas das enchentes no Rio Grande do Sul! |