📌 Conheça o website: https://agio-inventory-system.vercel.app/
- 1. Escopo da Aplicação 💡
- 2. Requisitos para Configuração do Ambiente 📋
- 3. Etapas para a Execução do Ambiente 🔧
- 4. Como Contribuir com o Projeto? 💻
- 5. Política de Segurança e Releases 🔑
- 6. Equipe de Desenvolvimento 👥
O Agio, ou Aplicação de Gestão de Inventário Otimizada, é um sistema open source web simples da disciplina de Métodos de Desenvolvimento de Software, da Universidade de Brasília. Desenvolvido com o objetivo de servir como um controle de inventário de uma corporação de pequeno a médio porte, é capaz de fornecer ao usuário uma maneira de gerenciar os itens presentes no inventário, adicionando e removendo os componentes de acordo com sua necessidade e monitorando-os de forma prática, simples e segura.
Ao utilizar os serviços do nosso projeto, um usuário encontrará uma série de funcionalidades, dentre elas:
- Criação do superusuário, o qual controla quem pode acessar/editar o inventário;
- Login e Logout de usuários, com controle de acesso às páginas;
- Registro das informações de usuário e de inventário em um banco de dados;
- Acesso ao inventário, permitindo visualização dos itens nele presentes;
- Adição, remoção e edição dos itens em um inventário;
- Visualização em sequência personalizada dos itens do inventário;
- Exportação dos componentes de um inventário para um arquivo .CSV;
- Entre outras, a serem implementadas.
No GIF abaixo, é possível conferir uma demonstração rápida das funções básicas da aplicação:
- Clone o repositório;
git clone https://github.com/unb-mds/2024-2-Squad04
- Navegue até o diretório do projeto;
cd PROJECT - Crie um ambiente virtual e ative-o;
python -m venv .venv .venv/scripts/activate
- Instale as dependências;
pip install -r requirements.txt
- Baixe o Docker Desktop (Docker Engine, no linux) no site oficial do docker;
- Crie um arquivo ".env" e insira as variáveis do projeto (requisite-as com os desenvolvedores);
- Execute o container do docker-compose.yml;
docker compose up -d
- Navegue até a raiz do projeto;
cd src - Gere os arquivos de migração;
python manage.py makemigrations
- Aplique as migrações do banco de dados;
python manage.py migrate
- Inicie o servidor de desenvolvimento;
python manage.py runserver
- Acesse, no navegador, o IP no qual a porta foi aberta. Padrão: XXX.X.X.X:8000
- E pronto! Assim o ambiente do projeto estará pronto para execução.
- Leia a documentação do projeto no README
- Certifique-se de que sua ideia ou problema ainda não foi reportado.
Ao encontrar um problema, abra uma issue no repositório seguindo o modelo:
- Descrição: Explique o problema de forma clara e objetiva.
- Reprodução: Liste os passos para reproduzir o problema.
- Resultado Esperado: O que deveria acontecer?
- Resultado Atual: O que realmente aconteceu?
- Extras: Inclua capturas de tela ou logs, se aplicável.
Se desejar sugerir uma nova funcionalidade, abra uma issue com:
- Descrição: Explique detalhadamente sua proposta.
- Motivação: Por que a funcionalidade é importante?
- Exemplo de Uso: Descreva como a funcionalidade seria usada.
Para contribuir com código, siga estas etapas:
- Faça um fork deste repositório.
- Crie uma branch para sua funcionalidade ou correção.
- Implemente suas alterações.
- Envie as alterações e crie um pull request.
Para mais informações sobre estrutura de commits e tecnologias utilizadas, consulte o arquivo CONTRIBUTING.
As releases que atualmente possuem as verificações necessárias de segurança estão descritas na tabela abaixo.
| Version | Safety Features |
|---|---|
| 1.0.0 | ✅ |
Para mais informações relacionadas a segurança e a notas de vulnerabilidades, consulte o arquivo SECURITY.
| Scrum Master | Product Owner | Front-End Developer | Back-End Developer | Front-End Developer | Architect |
|---|---|---|---|---|---|
 |
 |
 |
 |
 |
 |
| Caio Venâncio | Eduardo de Pina | Enzo Emir | João Maurício | Marcelo Makoto | Victor Pontual |