docs: update readme.md

Author: devruso

README.md

@@ -1,85 +1,124 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
-</p>
-
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
-
-  <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" alt="Donate us"/></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" alt="Follow us on Twitter"></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)-->
-
-## Description
-
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
-
-## Project setup
-
-```bash
-$ npm install
-```
 
-## Compile and run the project
+# Corpora - Backend
 
-```bash
-# development
-$ npm run start
+Este é o backend da aplicação **Corpora**, desenvolvido com **NestJS** utilizando **TypeScript**. Ele fornece serviços para autenticação, autorização, integração com OAuth (Google) e gerenciamento de empresas associadas a usuários.
 
-# watch mode
-$ npm run start:dev
+---
 
-# production mode
-$ npm run start:prod
-```
+## 🚀 Funcionalidades
 
-## Run tests
+- Autenticação e autorização com **JWT** e **OAuth Google**.
+- Suporte a guardas para controle de acesso: **Local**, **JWT** e **Google**.
+- Operações CRUD para empresas (Create, Read, Update, Delete).
+- Estrutura modular seguindo princípios **SOLID** e organização limpa.
+- Conexão com **MySQL** usando **TypeORM**.
 
-```bash
-# unit tests
-$ npm run test
+---
 
-# e2e tests
-$ npm run test:e2e
+## 🛠️ Tecnologias
 
-# test coverage
-$ npm run test:cov
-```
+- **NestJS** (Framework para Node.js)
+- **TypeScript**
+- **JWT** para autenticação
+- **OAuth2** para login com Google
+- **MySQL** como banco de dados
+- **TypeORM** para modelagem e gerenciamento do banco de dados
+
+---
+
+## ⚙️ Configuração do Ambiente
+
+1. **Instale as dependências:**
+   ```bash
+   npm install
+   ```
+
+2. **Configure o arquivo `.env`:**  
+   Crie um arquivo `.env` na raiz do projeto e adicione os seguintes valores que existem no arquivo `.env.example`:
+
+   ```plaintext
+   DB_HOST=localhost
+   DB_PORT=3306
+   DB_USER=root
+   DB_PASSWORD=sua_senha_do_banco
+   DB_NAME=corpora
+   JWT_SECRET=12345
+   JWT_EXPIRES_IN=1d
+   REFRESH_JWT_SECRET=12345
+   REFRESH_JWT_EXPIRES_IN=7d
+   GOOGLE_CLIENT_ID=seu_google_client_id
+   GOOGLE_SECRET=seu_google_secret
+   GOOGLE_CALLBACK_URL=http://localhost:3000/auth/google/callback
+   ```
+
+3. **Tenha um servidor MySQL configurado:**  
+
+   ```
 
-## Resources
+---
 
-Check out a few resources that may come in handy when working with NestJS:
+## 🏃 Executando o Backend
 
-- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
-- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
-- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
-- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
-- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
-- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
-- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
+1. **Modo de Desenvolvimento:**
+   ```bash
+   npm run start:dev
+   ```
 
-## Support
+---
 
-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).
+## 📖 Decisões Técnicas
 
-## Stay in touch
+- **Modularidade e SOLID:**  
+  A arquitetura do backend foi projetada com módulos independentes e bem definidos, como `AuthModule`, `UserModule`, e `CompanyModule`, seguindo o princípio da **separação de responsabilidades**. Isso permite que novas funcionalidades sejam adicionadas ou alteradas com impacto mínimo em outras partes do sistema.
 
-- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
+- **NestJS Framework:**  
+  O NestJS foi escolhido por sua abordagem opinativa e sua aderência aos princípios da engenharia de software, como o SOLID. Ele oferece uma estrutura robusta e escalável, permitindo a criação de APIs RESTful com práticas modernas.
 
-## License
+- **TypeORM:**  
+  Utilizado para simplificar a interação com o banco de dados MySQL. Com ele, foi possível:
+  - Gerenciar entidades com facilidade.
+  - Sincronizar o esquema do banco de dados.
+  - Garantir a consistência e integridade dos dados por meio de validações a nível de entidade.
+
+- **Guards para Controle de Acesso:**  
+  Os **Guards** do NestJS foram essenciais para proteger as rotas e garantir que somente usuários autorizados pudessem realizar determinadas ações. As implementações incluem:
+  - **LocalGuard:** Realiza a autenticação inicial do usuário com credenciais tradicionais.
+  - **JwtGuard:** Verifica e valida tokens JWT para proteger rotas de acesso restrito.
+  - **GoogleGuard:** Facilita o login com OAuth 2.0 do Google, integrando a autenticação social de forma segura.
+
+- **Injeção de Dependência:**  
+  O uso nativo do NestJS para gerenciar dependências tornou o código mais limpo e fácil de testar, promovendo a reutilização de serviços e a manutenção do projeto.
+
+---
+
+## 🔑 Configuração do OAuth Google
+
+1. Acesse o [Console de API do Google](https://console.developers.google.com/).
+2. Crie um projeto e habilite o **OAuth 2.0**.
+3. Adicione as seguintes URLs de redirecionamento:
+   - **`http://localhost:3000/auth/google/callback`**
+4. Copie o **Client ID** e **Secret** e configure no `.env`, substituindo os valores das variáveis existentes.
+
+---
+
+## 📂 Estrutura do Projeto
+
+```plaintext
+src/
+├── auth/                 # Módulo de autenticação
+├── auth/decorators       # Decorator para role de usuario
+├── auth/enums            # Enum de role de usuario
+├── auth/guard            # Validação de rota com tipo de autenticação
+├── auth/jwt              # Configuração do token e refresh token do jwt 
+├── company/              # Módulo de empresas
+├── config/               # Configuração do google 
+├── dto/                  # Dto de paginação
+├── strategies/           # Estratégias de autenticação
+├── typeOrm/              # Configuração das entidades do banco de dados
+├── user/                 # Modulo de usuario
+├── utils/                # Tamanho padrão do retorno de uma requisicao
+├── main.ts               # Arquivo principal
+├── database-init.ts      # Arquivo de configuração do banco de dados
+```
 
-Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
+---