Análise de Gastos Públicos do Distrito Federal
Projeto desenvolvido para a disciplina Métodos de Desenvolvimento de Software.
📑 Descrição do Projeto
Este projeto consiste na criação de um site hospedado no GitHub Pages para a análise e visualização dos gastos públicos do Distrito Federal. O objetivo é proporcionar uma plataforma acessível que permita aos cidadãos, estudantes e profissionais entender e acompanhar a alocação de recursos públicos no DF, promovendo transparência e conscientização.
📌 Objetivos
- Analisar e organizar dados públicos sobre os gastos do DF.
- Visualizar dados de forma intuitiva para facilitar a compreensão.
- Promover transparência ao permitir que os usuários acompanhem os gastos em diferentes setores, como saúde, educação e segurança.
- Aplicar práticas de desenvolvimento colaborativo usando Git e GitHub, alinhadas às boas práticas discutidas em sala de aula.
⚙️ Tecnologias Utilizadas
- HTML, CSS: Para a construção do front-end.
- Python: Para a construção do front-end.
- GitHub: Para controle de versão e colaboração entre os membros do grupo.
- GitHub Pages: Para hospedagem do site de documentação.
- Railway: Para hospedagem do site.
👥 Colaboradores
O projeto está sendo desenvolvido por um grupo de seis alunos da disciplina, conforme lista abaixo:
- Arthur Mendonça - Desenvolvedor
- Gabriel da Cunha - Product Owner
- Gabriel Lopes - Desenvolvedor
- João Pedro - Desenvolvedor e estruturador da maioria das issues.
- Julia Gabriela - Scrum Master
- Lucas Mendonça - Desenvolvedor
🚀 Estrutura do Projeto
O repositório está organizado da seguinte maneira:
- /documentacao - Arquivos de documentação que auxiliam a entender o desenvolvimento do projeto.
- /codigo - Código para ser executado na máquina do usuário caso ele deseje.
- Requirements.txt - Dependências do projeto.
👨💻 Instalação e uso
Comandos básicos necessários:
Primeiro, use o comando git clone https://github.com/unb-mds/Squad13
para conseguir clonar esse repositório em sua máquina.
Depois, use o comando cd Squad13
para acessar o diretório principal do repositório.
Caso haja atualizações e já tenha clonado o repositório na máquina, será necessário utilizar o comando git pull
no diretório principal para atualizar o repositório local.
Instale as dependências por meio do pip install -r requirements.txt.
Acesse a pasta código.
Para Acessar o site localmente será preciso executar o arquivo app.py com o comando no terminal python3 app.py
. Após a execução do arquivo, será gerado um link http://localhost, basta apertar a tecla ctrl e clicar com o mouse esquerdo no link, ou colar o link no navegador para acessar o site diretamente de sua máquina.
🤝 Como Contribuir
Agradecemos seu interesse em contribuir para o desenvolvimento deste projeto! Seguem algumas diretrizes para que sua colaboração seja eficiente e produtiva:
-
Leia a documentação do projeto Antes de começar, familiarize-se com o propósito do repositório e os objetivos do projeto. Leia a documentação para entender melhor como funciona.
-
Abra uma issue Se encontrou um bug, deseja sugerir uma nova funcionalidade ou possui alguma dúvida, abra uma issue descrevendo o problema ou sugestão. Detalhe ao máximo para facilitar o entendimento.
-
Escolha uma issue e comente Consulte as issues abertas e, caso queira trabalhar em uma delas, deixe um comentário informando que irá contribuir. Assim, evitamos que várias pessoas trabalhem no mesmo problema sem coordenação.
-
Crie um fork do repositório Faça um fork do repositório para sua conta do GitHub e crie uma nova branch a partir da
develop
para trabalhar nas suas alterações:
bash
git checkout -b minha-contribuicao
-
Desenvolva e teste suas alterações Garanta que o código segue o estilo definido no projeto e que todas as alterações foram testadas localmente. Para isso, siga as orientações do arquivo de padrões do projeto e estude como nossos arquivos, tanto de documentação como de código, estão estruturados.
-
Envie um pull request (PR) Após concluir o desenvolvimento, envie um pull request para a branch de desenvolvimento (
develop
). No PR, siga os padrões do projeto, incluindo referências às issues relacionadas. O PR não será aceito caso não siga os padrões definidos. -
Aguarde a revisão Os mantenedores do projeto revisarão seu pull request, podendo solicitar ajustes ou discutir as alterações. Esteja disponível para responder às dúvidas e realizar as correções necessárias.
🌟 Dicas Importantes
- Siga o padrão de nomenclatura e estilo de código adotado pelo projeto.
- Atualize a documentação, se necessário, para refletir suas mudanças.
- Seja respeitoso e colaborativo com outros contribuidores e mantenedores.
Toda contribuição, grande ou pequena, é valiosa para nós. Obrigado por ajudar a construir algo incrível juntos! 🚀
Se precisar de ajuda ou orientação, não hesite em perguntar nos canais de comunicação do projeto.
📈 Dados Utilizados
Os dados de gastos públicos do DF foram coletados a partir de bases de dados oficiais disponíveis publicamente, como portais de transparência. Durante o projeto, os dados serão filtrados, categorizados e formatados para otimizar a visualização e análise.
🌐 Acesso ao Site
O projeto será hospedado no GitHub Pages e pode ser acessado pelo link: Gastos Públicos do Distrito Federal.
🔨 Ferramentas
📞 Contato
Caso tenha dúvidas ou sugestões, entre em contato com um dos colaboradores.
- Email: gastosdfmonitor@gmail.com
Histórico de versões
Versão | Data | Descrição | Autor | Revisão |
---|---|---|---|---|
0.1.0 |
30/10/2024 | Estruturação do README do projeto | Julia Gabriela | Lucas Mendonça |
0.1.1 |
01/12/2024 | Ajustes do README do projeto | Julia Gabriela | Gabriel da Cunha |
0.2.0 |
01/12/2024 | Adição da seção de contribuição | Gabriel da Cunha | Julia Gabriela |
0.3.0 |
01/12/2024 | Adição da seção de ferramentas | João Pedro | Artur Mendonça |
0.3.1 |
09/12/2024 | correção do url do site | Gabriel da Cunha | João Pedro |