readme do backend criado

unb-mds · Dec 10, 2024 · fb7c293 · fb7c293
1 parent 721f0c0
commit fb7c293
Show file tree

Hide file tree

Showing 33 changed files with 185 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -8,9 +8,7 @@
   - [📱 Tecnologias](#-tecnologias)
   - [🧑‍🏭 Executando a aplicação](#-executando-a-aplicação)
     - [📋 Pré-requisitos](#-pré-requisitos)
-    - [Frontend](#-frontend)
-    - [Backend](#-Backend)
-  - [💻 Ambiente](#-ambiente)
+  - [💻 Back-End](#-back-end)
   - [📚 Documentação](#-documentação)
   - [👥 Colaboradores](#-colaboradores)
 
@@ -47,26 +45,9 @@ Para rodar o projeto, você precisa das seguintes ferramentas:
 - **Node.js** v20 ou superior
 - **Python** 3.12.3
 
-### Frontend
+## 💻 Back-End
 
-Clone o repositório
-
-```bash
-git clone https://github.com/unb-mds/LicitaBSB-24.1.git
-```
-
-Navegue até o diretório frontend e instale as dependências:
-```bash
-npm install
-```
-Para rodar o projeto, execute:
-```bash
-npm run build
-npm run dev
-```
-### Backend
-
-## 💻 Ambiente
+Acesse a completa do README.md [**Aqui**](#)
 
 ## 📚 Documentação
 

diff --git a/backend/README.md b/backend/README.md
@@ -0,0 +1,182 @@
+# [Urbanize](#)
+
+---
+
+Para melhor divisão e organização, o Urbanize está dividido em dois repositórios.
+
+Você está no **Backend**:
+
+---
+
+O [Urbanize](#) é um projeto desenvolvido na disciplina Métodos de Desenvolvimento de Software (MDS) ofertada no curso de Engenharia de Software na Universidade de Brasília (UnB), que visa reunir em um único local dados sobre obras publicas, utilizando informações extraídas da pesquisa educacional realizada pelo ObrasGov. A plataforma permite diferentes interpretações dos dados e progresso das obras.
+
+O projeto é um software livre e está sob a licença [MIT](./LICENSE).
+
+---
+
+## 🗒️ Sumário
+
+- [Urbanize](#urbanize)
+  - [🗒️ Sumário](#️-sumário)
+  - [🏁 Início](#-início)
+    - [🏞️ Ambiente e Pré-requisitos](#️-ambiente-e-pré-requisitos)
+    - [📲 Instalação](#-instalação)
+      - [**Express/API**](#expressapi)
+      - [**Scraper**](#scraper)
+    - [⚙️ Execução](#️-execução)
+      - [**Express/API**](#expressapi-1)
+      - [**Scraper**](#scraper-1)
+      - [**ETL**](#etl)
+  - [🛠️ Guia de contribuição](#️-guia-de-contribuição)
+  - [📒 Documentação e muito mais!](#-documentação-e-muito-mais)
+
+---
+
+## 🏁 Início
+
+Siga os passos abaixo para executar o **backend** do [**Urbanize**](#):
+
+### 🏞️ Ambiente e Pré-requisitos
+
+Para rodar o projeto é fundamental ter algumas dependências globais:
+
+- Node
+- Miniconda/Python
+
+Para visualizar versões, links e as instruções completas de configuração do ambiente: [**Ambiente e Pré-requisitos**](https://unb-mds.github.io/2024-1-EducaMinas-frontend/environment/)
+
+
+### 📲 Instalação
+
+Após configurar o [**Ambiente e Pré-requisitos**](https://unb-mds.github.io/2024-1-EducaMinas-frontend/environment/), em um diretório de sua máquina, abra o terminal e execute:
+
+```bash
+git clone https://github.com/unb-mds/2024-2-Urbanize.git
+```
+
+Com o repositório do backend devidamente clonado, você terá acesso à aplicação **Express** e ao **Scraper**:
+
+#### **Express/API**
+
+Navegue até o diretório raiz do repositório clonado:
+
+```bash
+cd 2024-2-Urbanize
+```
+Em seguida instale as dependências do Urbanize:
+
+```bash
+npm install
+```
+
+#### **Scraper**
+
+Navegue até o diretório `WebScrapper`:
+
+```bash
+cd WebScrapper
+```
+Crie um ambiente virtual com conda:
+
+```bash
+conda create --name <my-env>
+```
+
+Ative o ambiente criado:
+
+```bash
+conda activate <my-env>
+```
+
+Instale as dependências e bibliotecas dentro do ambiente virtual:
+
+```bash
+conda install --yes --file requirements.txt
+```
+
+O script ETL acessa o banco de dados por meio de um `.env` encontrado no caminho
+`WebScrapper/DataETL/.env`. A sua estrutura está escrita abaixo:
+
+```bash
+DATABASE_USERNAME=<INSERIR AQUI>
+DATABASE_PASSWORD=<INSERIR AQUI>
+DATABASE_NAME=<INSERIR AQUI>
+DATABASE_PORT=<INSERIR AQUI>
+DATABASE_HOST=<INSERIR AQUI>
+```
+
+
+### ⚙️ Execução
+
+#### **Express/API**
+
+Para executar a aplicação Express em sua máquina, execute no diretório raiz:
+
+```bash
+npm run start
+```
+O servidor será inicializado e estará disponível na porta 3001 do localhost:
+
+```bash
+http://localhost:3333/
+```
+
+Demais comandos para execução de testes, builds e linter podem ser encontrados na guia _scripts_  do arquivo `package.json` na pasta raiz.
+
+Com a api rodando localmente é possível acessar sua documentação e testá-la no **Swagger**, basta acessar:
+
+```bash
+http://localhost:3001/api-docs
+```
+
+#### **Scraper**
+
+Com o ambiente ativado como instruído acima, para extrair os dados do Oracle Data com o selenium execute:
+
+```bash
+DataScraper/InepScrapper.py
+```
+
+#### **ETL**
+
+Para tratar e carregar os dados extraídos, em modo debugger, acesse `WebScrapper/DataETL`, lembre-se de selecionar o ambiente conda que foi criado, e então para rodar o programa por partes, execute:
+
+```bash
+ETLDebugger.ipynb
+```
+
+Se preferir, e não precisar/quiser rodar em modo debugger(por partes), execute o código para produção:
+
+```bash
+python3 WebSrapper/DataETL/main.py
+```
+
+---
+
+## 🛠️ Guia de contribuição
+
+**Para acessar o guia completo de contribuição**: [**Guia de Contribuição**](https://unb-mds.github.io/2024-2-Urbanize/)
+
+---
+
+## 📒 Documentação e muito mais!
+
+**Para acessar a documentação completa**: [**Documentação Urbanize**](https://unb-mds.github.io/2024-2-Urbanize/)
+
+Nela, você encontra os seguintes tópicos:
+
+- [Início](https://unb-mds.github.io/2024-2-Urbanize/)
+- [Sprints](https://unb-mds.github.io/2024-2-Urbanize/sprints/sprint-0/)
+- [Projeto](https://unb-mds.github.io/2024-2-Urbanize/project/personas/):
+    - [Personas](https://unb-mds.github.io/2024-2-Urbanize/project/personas/)
+    - [StoryMap](https://unb-mds.github.io/2024-2-Urbanize/project/storymap/)
+    - [Requisitos](https://unb-mds.github.io/2024-2-Urbanize/project/requirements/)
+    - [EAP](https://unb-mds.github.io/2024-2-Urbanize/project/eap/)
+    - [API](https://unb-mds.github.io/2024-2-Urbanize/project/servicos/)
+    - [Arquitetura e Tecnologias](https://unb-mds.github.io/2024-2-Urbanize/project/arquitetura/)
+    - [Protótipo](https://unb-mds.github.io/2024-2-Urbanize/project/prototipo/)
+- [Como contribuir](https://unb-mds.github.io/2024-2-Urbanize/environment/):
+    - [Ambiente de desenvolvimento](https://unb-mds.github.io/2024-2-Urbanize/environment/)
+    - [Primeiros passos - frotend](https://unb-mds.github.io/2024-2-Urbanize/contributing-frontend/)
+    - [Primeiros passos - backend](https://unb-mds.github.io/2024-2-Urbanize/contributing-backend/)
+- [Sobre](https://unb-mds.github.io/2024-2-Urbanize/about/)
diff --git a/backend/.gitignore → backend/node/.gitignore b/backend/.gitignore → backend/node/.gitignore
diff --git a/backend/docker-compose.yml → backend/node/docker-compose.yml b/backend/docker-compose.yml → backend/node/docker-compose.yml
diff --git a/backend/package-lock.json → backend/node/package-lock.json b/backend/package-lock.json → backend/node/package-lock.json
diff --git a/backend/package.json → backend/node/package.json b/backend/package.json → backend/node/package.json
diff --git a/...41114181751_projeto_created/migration.sql → ...41114181751_projeto_created/migration.sql b/...41114181751_projeto_created/migration.sql → ...41114181751_projeto_created/migration.sql
diff --git a/...183159_relacionando_tabelas/migration.sql → ...183159_relacionando_tabelas/migration.sql b/...183159_relacionando_tabelas/migration.sql → ...183159_relacionando_tabelas/migration.sql
diff --git a/...14195423_melhoria_de_tabela/migration.sql → ...14195423_melhoria_de_tabela/migration.sql b/...14195423_melhoria_de_tabela/migration.sql → ...14195423_melhoria_de_tabela/migration.sql
diff --git a/...38_mudando_o_tipo_de_origem/migration.sql → ...38_mudando_o_tipo_de_origem/migration.sql b/...38_mudando_o_tipo_de_origem/migration.sql → ...38_mudando_o_tipo_de_origem/migration.sql
diff --git a/...dicionando_fonte_de_recurso/migration.sql → ...dicionando_fonte_de_recurso/migration.sql b/...dicionando_fonte_de_recurso/migration.sql → ...dicionando_fonte_de_recurso/migration.sql
diff --git a/.../migrations/20241114202836_/migration.sql → .../migrations/20241114202836_/migration.sql b/.../migrations/20241114202836_/migration.sql → .../migrations/20241114202836_/migration.sql
diff --git a/...1114215653_especie_opcional/migration.sql → ...1114215653_especie_opcional/migration.sql b/...1114215653_especie_opcional/migration.sql → ...1114215653_especie_opcional/migration.sql
diff --git a/...20241114232428_mudando_tipo/migration.sql → ...20241114232428_mudando_tipo/migration.sql b/...20241114232428_mudando_tipo/migration.sql → ...20241114232428_mudando_tipo/migration.sql
diff --git a/...s/20241114233015_int_codigo/migration.sql → ...s/20241114233015_int_codigo/migration.sql b/...s/20241114233015_int_codigo/migration.sql → ...s/20241114233015_int_codigo/migration.sql
diff --git a/...ions/20241114233505_big_int/migration.sql → ...ions/20241114233505_big_int/migration.sql b/...ions/20241114233505_big_int/migration.sql → ...ions/20241114233505_big_int/migration.sql
diff --git a/...migrations/20241114234133_a/migration.sql → ...migrations/20241114234133_a/migration.sql b/...migrations/20241114234133_a/migration.sql → ...migrations/20241114234133_a/migration.sql
diff --git a/...end/prisma/migrations/migration_lock.toml → ...ode/prisma/migrations/migration_lock.toml b/...end/prisma/migrations/migration_lock.toml → ...ode/prisma/migrations/migration_lock.toml
diff --git a/backend/prisma/schema.prisma → backend/node/prisma/schema.prisma b/backend/prisma/schema.prisma → backend/node/prisma/schema.prisma
diff --git a/backend/src/container/container.ts → backend/node/src/container/container.ts b/backend/src/container/container.ts → backend/node/src/container/container.ts
diff --git a/...end/src/controllers/ProjetosController.ts → ...ode/src/controllers/ProjetosController.ts b/...end/src/controllers/ProjetosController.ts → ...ode/src/controllers/ProjetosController.ts
diff --git a/...trollers/schemas/ProjetosRequestSchema.ts → ...trollers/schemas/ProjetosRequestSchema.ts b/...trollers/schemas/ProjetosRequestSchema.ts → ...trollers/schemas/ProjetosRequestSchema.ts
diff --git a/backend/src/database/fetchAPI.ts → backend/node/src/database/fetchAPI.ts b/backend/src/database/fetchAPI.ts → backend/node/src/database/fetchAPI.ts
diff --git a/backend/src/database/index.ts → backend/node/src/database/index.ts b/backend/src/database/index.ts → backend/node/src/database/index.ts
diff --git a/backend/src/error/HttpError.ts → backend/node/src/error/HttpError.ts b/backend/src/error/HttpError.ts → backend/node/src/error/HttpError.ts
diff --git a/backend/src/middlewares/error-handling.ts → ...nd/node/src/middlewares/error-handling.ts b/backend/src/middlewares/error-handling.ts → ...nd/node/src/middlewares/error-handling.ts
diff --git a/...tories/prisma/PrismaProjetosRepository.ts → ...tories/prisma/PrismaProjetosRepository.ts b/...tories/prisma/PrismaProjetosRepository.ts → ...tories/prisma/PrismaProjetosRepository.ts
diff --git a/...end/src/repositories/projetoRepository.ts → ...ode/src/repositories/projetoRepository.ts b/...end/src/repositories/projetoRepository.ts → ...ode/src/repositories/projetoRepository.ts
diff --git a/backend/src/routes/routes.ts → backend/node/src/routes/routes.ts b/backend/src/routes/routes.ts → backend/node/src/routes/routes.ts
diff --git a/backend/src/server.ts → backend/node/src/server.ts b/backend/src/server.ts → backend/node/src/server.ts
diff --git a/backend/src/use-cases/ProjetosService.ts → ...end/node/src/use-cases/ProjetosService.ts b/backend/src/use-cases/ProjetosService.ts → ...end/node/src/use-cases/ProjetosService.ts
diff --git a/backend/src/utils/AppError.ts → backend/node/src/utils/AppError.ts b/backend/src/utils/AppError.ts → backend/node/src/utils/AppError.ts
diff --git a/backend/tsconfig.json → backend/node/tsconfig.json b/backend/tsconfig.json → backend/node/tsconfig.json