Update README.md

Author: rhuam

README.md

@@ -1,73 +1,67 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
-</p>
+# README para o Backend do App de Ajuda em Enchentes
 
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
+Este repositório contém o backend de um aplicativo desenvolvido para organizar e distribuir suprimentos, bem como coordenar voluntários durante os alagamentos no Rio Grande do Sul. O backend fornece APIs para autenticação de usuários, gerenciamento de abrigos e suprimentos, entre outros.
 
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+## Sobre o Projeto
 
-## Description
+O sistema backend é projetado para ser robusto e escalável, garantindo que possa lidar com o alto volume de acessos durante emergências. Ele opera com diversas APIs que permitem a interação com o frontend e outros serviços potenciais.
 
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+## Tecnologias Utilizadas
 
-## Installation
+- **Node.js**: Ambiente de execução para JavaScript.
+- **Express**: Framework para aplicação web para Node.js.
+- **MongoDB**: Banco de dados NoSQL para armazenar dados de forma eficiente.
+- **JWT**: Para autenticação segura via tokens.
 
-```bash
-$ npm install
-```
+## API Endpoints
 
-## Running the app
+### Usuários
+- **POST /users** - Cadastrar um novo usuário.
+- **PUT /users** - Atualizar um usuário existente.
 
-```bash
-# development
-$ npm run start
+### Sessões
+- **POST /sessions** - Criar uma nova sessão de usuário (login).
+- **GET /sessions/:sessionId** - Obter detalhes de uma sessão.
+- **PUT /sessions/:sessionId** - Atualizar uma sessão específica.
 
-# watch mode
-$ npm run start:dev
+### Abrigos
+- **POST /shelters** - Cadastrar um novo abrigo.
+- **PUT /shelters/:shelterId** - Atualizar um abrigo existente.
+- **GET /shelters** - Listar abrigos.
 
-# production mode
-$ npm run start:prod
-```
+### Suprimentos
+- **POST /supply** - Cadastrar um novo item de suprimento.
+- **PUT /supplies/:supplyId** - Atualizar um suprimento.
+- **GET /supplies** - Listar suprimentos.
 
-## Test
+### Categorias de Suprimentos
+- **POST /supply-categories** - Cadastrar uma nova categoria de suprimentos.
+- **PUT /supply-categories/:categoryId** - Atualizar uma categoria de suprimentos.
+- **GET /supply-categories** - Listar categorias de suprimentos.
 
-```bash
-# unit tests
-$ npm run test
+## Configuração Inicial
 
-# e2e tests
-$ npm run test:e2e
+1. Clone o repositório:
+   ```bash
+   git clone https://github.com/seuusuario/projeto-enchentes-backend.git
+   ```
+2. Entre no diretório do projeto:
+   ```bash
+   cd projeto-enchentes-backend
+   ```
+3. Instale as dependências:
+   ```bash
+   npm install
+   ```
+4. Inicie o servidor:
+   ```bash
+   npm start
+   ```
+   A API estará acessível via `http://localhost:4000`.
 
-# test coverage
-$ npm run test:cov
-```
+## Contribuição
 
-## Support
+Contribuições são bem-vindas! Se quiser contribuir, por favor faça um fork do repositório, crie uma branch para suas modificações e depois envie um pull request.
 
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
 
-## Stay in touch
-
-- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
-
-## License
-
-Nest is [MIT licensed](LICENSE).
+Sua participação é essencial para ajudarmos a comunidade afetada pelas enchentes no Rio Grande do Sul!