Merge pull request #53 from unb-mds/dev

.gitignore

@@ -0,0 +1,49 @@
+# Frontend
+# dependencies
+client/node_modules/
+client/.pnp/
+client/.pnp.js
+
+# testing
+client/coverage/
+
+# production
+client/build/
+
+# misc
+client/.DS_Store
+client/.env.local
+client/.env.development.local
+client/.env.test.local
+client/.env.production.local
+
+client/npm-debug.log*
+client/yarn-debug.log*
+client/yarn-error.log*
+
+# Backend
+# Virtual environment
+.venv/
+env/
+venv/
+
+# Environment variables
+server/.env
+
+# Compiled Python files
+server/**/*.pyc
+server/**/__pycache__/
+
+# Django migrations (except __init__.py)
+server/*/migrations/[!__init__]*.py
+server/*/migrations/[!__init__]*.pyc
+
+# Miscellaneous
+*.log
+*.sqlite3
+*.swp
+*.swo
+
+# IDE files
+.vscode/
+.idea/

.prettierrc

@@ -0,0 +1,23 @@
+{
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "endOfLine": "lf",
+  "htmlWhitespaceSensitivity": "css",
+  "insertPragma": false,
+  "singleAttributePerLine": false,
+  "bracketSameLine": false,
+  "jsxBracketSameLine": false,
+  "jsxSingleQuote": false,
+  "printWidth": 80,
+  "proseWrap": "preserve",
+  "quoteProps": "as-needed",
+  "requirePragma": false,
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "useTabs": false,
+  "embeddedLanguageFormatting": "auto",
+  "vueIndentScriptAndStyle": false,
+  "experimentalTernaries": false
+}

README.md

@@ -1,6 +1,9 @@
 # 📊 Monitoramento de Gastos Públicos
+
 Este projeto foi desenvolvido para a disciplina Métodos de Desenvolvimento de Software na Universidade de Brasília (UnB) durante o segundo semestre de 2024
+
 ## 🗂️ Sumário
+
 - [📜 Descrição do Projeto](#-descrição-do-projeto)
 - [✔️ Funcionalidades](#-funcionalidades)
 - [🛠️ Ferramentas Utilizadas](#️-ferramentas-utilizadas)
@@ -12,30 +15,127 @@ Este projeto foi desenvolvido para a disciplina Métodos de Desenvolvimento de S
 - [📍 Licença](#-licença)
 
 ## 📜 Descrição do Projeto
-*Monitoramento de Gastos Públicos* é um projeto o qual fornecerá uma interface acessível para que cidadãos, estudantes e profissionais possam visualizar e compreender padrões de gastos, fornecedores recorrentes e possíveis irregularidades nas contas dos municípios do estado de Alagoas.
 
+_Monitoramento de Gastos Públicos_ é um projeto o qual fornecerá uma interface acessível para que cidadãos, estudantes e profissionais possam visualizar e compreender padrões de gastos, fornecedores recorrentes e possíveis irregularidades nas contas do município de Maceió
 
 ## ✔️ Funcionalidades
 
 Esta seção será atualizada com uma lista das principais funcionalidades do projeto em breve.
 
 ## 🛠️ Ferramentas Utilizadas
 
-- **HTML e CSS**: Para a construção da estrutura e estilização das páginas web, garantindo uma interface visual atraente e responsiva.
+- **React e TailwindCSS**: Para a construção da estrutura e estilização das páginas web, garantindo uma interface visual atraente e responsiva.
 - **Python**: Linguagem de programação utilizada para o desenvolvimento do backend e automações.
 - **Django**: Framework utilizado para a criação do backend, gerenciamento de banco de dados e APIs REST.
-- **React**: Biblioteca JavaScript utilizada para o desenvolvimento do frontend, oferecendo uma interface dinâmica e responsiva.
-- **Querido Diário**: Biblioteca utilizada para a extração automatizada de dados dos diários oficiais dos municípios do estado de Alagoas, facilitando o acesso a informações sobre gastos públicos municipais.
+- **React com Typescript**: Biblioteca JavaScript, com suporte a typescript, utilizada para o desenvolvimento do frontend, oferecendo uma interface dinâmica e responsiva.
+- **Querido Diário**: Biblioteca utilizada para a extração automatizada de dados dos diários oficiais de Maceió, AL, facilitando o acesso a informações sobre gastos públicos municipais.
 
 ## 📋 Estrutura do Projeto
 
-Estrutura detalhada será adicionada em breve.
+```
+root/
+├──  client/
+│   ├──  node_modules/
+│   ├──  public/
+│   ├──  src/
+│   │   ├── components/
+│   │   │   ├── Componentes do projeto
+│   │   ├── hooks/
+│   │   │   ├── Hooks personalizados do projeto
+│   │   ├── pages/
+│   │   │   ├── Páginas do projeto
+│   │   ├── services/
+│   │   │   ├── serviços para comunicação do front com o back
+│   │   ├── App.css
+│   │   ├── App.tsx
+│   │   ├── index.css
+│   │   ├── index.tsx
+│   │   ├── setupTests.ts
+│   │   └── react-app-env.d.ts
+│   ├── tailwind.config.js
+│   ├── tsconfig.json
+│   ├── package.json
+│   └── README.md
+├──  server/
+│   ├── apps/
+│   │   ├── gastos_publicos/
+│   │   │   ├── controllers/
+│   │   │   │   ├── __init__.py
+│   │   │   │   └── example_controller.py
+│   │   │   ├── middlewares/
+│   │   │   │   ├── __init__.py
+│   │   │   │   └── example_middleware.py
+│   │   │   ├── migrations/
+│   │   │   │   ├── __init__.py
+│   │   │   ├── routes/
+│   │   │   │   ├── __init__.py
+│   │   │   │   └── example_routes.py
+│   │   │   ├── services/
+│   │   │   │   ├── __init__.py
+│   │   │   │   └── example_service.py
+│   │   │   ├── utils/
+│   │   │   │   ├── __init__.py
+│   │   │   │   ├── admin.py
+│   │   │   │   ├── apps.py
+│   │   │   │   ├── models.py
+│   │   │   │   ├── tests.py
+│   │   │   │   └── views.py
+│   │   │   └── __init__.py
+│   │   ├── server/
+│   │   ├── __init__.py
+│   │   ├── asgi.py
+│   │   ├── settings.py
+│   │   ├── urls.py
+│   │   ├── wsgi.py
+│   ├── .env
+│   ├── manage.py
+│   ├── README.md
+│   └── requirements.txt
+├── .gitignore
+└── README.md
+
+```
 
 ## 🚀 Como Executar o Projeto
 
-Instruções detalhadas de execução serão adicionadas em breve.
+### Front end:
+
+1. Navegue para a pasta `client/`, usando o comando:
+   ```
+   cd client/
+   ```
+2. Instale as depências usando o comando:
+   ```
+   npm install
+   ```
+3. Inicialize o front usando o comando:
+   ```
+   npm start #ou npm run start
+   ```
+4. Acesse o site no link: `http://localhost:3000/`
+
+---
+
+### Back end
+
+1. Navegue para a pasta `server/`, usando o comando:
+   ```
+        cd server/
+   ```
+2. Crie um arquivo `.env` na pasta `server/`, com os seguintes valores:
+
+   ```.env
+       DB_NAME=nome_do_banco
+       DB_USER=usuario
+       DB_PASSWORD=senha
+       DB_HOST=localhost
+       DB_PORT=3306
+   ```
+
+3. Siga o passo a passo do [README](/server/README.md) do back
 
 ## 📚 Documentação
+
 A documentação completa do projeto pode ser acessada [neste link](https://unb-mds.github.io/2024-2-Squad06/).
 
 ## 🤝 Como Contribuir
@@ -45,41 +145,46 @@ Se você deseja colaborar com o projeto, siga as etapas abaixo:
 1. **Faça um fork deste repositório** clicando no botão "Fork" no canto superior direito da página.
 
 2. **Clone o repositório forkado** para a sua máquina:
+
    ```bash
    git clone https://github.com/unb-mds/2024-2-Squad06
    ```
 
 3. **Crie uma branch** para realizar suas alterações:
+
    ```bash
    git checkout -b minha-feature
    ```
 
 4. Faça as alterações desejadas no código e adicione os arquivos modificados ao controle de versão:
+
    ```bash
    git add .
    ```
 
 5. Realize o commit das suas alterações:
+
    ```bash
    git commit -m "Descrição clara da feature ou correção"
    ```
 
 6. Envie as alterações para o seu fork:
+
    ```bash
    git push origin minha-feature
    ```
 
 7. **Abra um Pull Request** no repositório original.
 
 ### Regras para Colaboração
+
 - Certifique-se de seguir as convenções de estilo do código adotadas no projeto.
 - Adicione comentários claros para facilitar o entendimento do código.
 - Teste suas alterações localmente antes de abrir o Pull Request.
 - Inclua uma descrição detalhada no Pull Request, explicando as mudanças realizadas.
 
 Caso tenha dúvidas, entre em contato com a equipe do projeto por meio das [issues](https://github.com/unb-mds/2024-2-Squad06/issues).
 
-
 ## 👥 Colaboradores
 
 <center>
@@ -127,4 +232,3 @@ Caso tenha dúvidas, entre em contato com a equipe do projeto por meio das [issu
 ## 📍 Licença
 
 Este projeto está licenciado sob a [Licença MIT](https://github.com/unb-mds/2024-2-Squad06/blob/main/LICENSE).
-

client/README.md

@@ -0,0 +1,46 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).