Skip to content

Latest commit

 

History

History
234 lines (191 loc) · 8.02 KB

README.md

File metadata and controls

234 lines (191 loc) · 8.02 KB
Raw

📊 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

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

  • 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 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

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

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:

        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 do back

📚 Documentação

A documentação completa do projeto pode ser acessada neste link.

🤝 Como Contribuir

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:

    git clone https://github.com/unb-mds/2024-2-Squad06

  3. Crie uma branch para realizar suas alterações:

    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:

    git add .

  5. Realize o commit das suas alterações:

    git commit -m "Descrição clara da feature ou correção"

  6. Envie as alterações para o seu fork:

    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.

👥 Colaboradores

Kauã
Seichi
Tiago
Lemes
Ana
Luiza
Arthur
Guilherme
Nayra
Ingrid
Alves

📍 Licença

Este projeto está licenciado sob a Licença MIT.