diff --git a/README.md b/README.md index 0be3ac88..78d703bc 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ O objetivo deste aplicativo é facilitar uma resposta rápida e eficiente em sit Se você quiser discutir ideias, problemas ou contribuições, sinta-se à vontade para se juntar ao nosso servidor do Discord [aqui](https://discord.gg/vjZS6BQXvM). -## Acesso à Aplicação +## 🌎 Acesso à Aplicação [SOS Rio Grande do Sul](https://sos-rs.com/) @@ -18,21 +18,57 @@ Contribuições são muito bem-vindas! Se deseja ajudar, veja o Agradecemos o seu interesse e apoio. Juntos, podemos fazer uma diferença significativa para as vítimas das enchentes no Rio Grande do Sul! -## 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. -## Licença +**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. + +## 🤝 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 no seu ambiente 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 `` 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//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`. + +## 📋 Licença Este código está licenciado usando a [licença MIT](./LICENSE). -## Contribuidores +## ❤️ Contribuidores Os contribuidores são voluntários, e podem ser encontrados [na página de contribuidores](https://github.com/SOS-RS/frontend/graphs/contributors).