Este projeto visa desenvolver um software para o gerenciamento de estoque e agendamento para um estúdio de tatuagem. O sistema atenderá as necessidades de controle de estoque dos materiais, como produtos consumíveis, equipamentos e produtos de higiene, implementando processos de entrada, saída e monitoramento desses produtos. Além disso, ele oferecerá funcionalidades de agendamento, gerenciamento de clientes, e repositório de imagens separados por sessão, facilitando a organização dos compromissos do tatuador. Entre os recursos principais, estão relatórios de estoque e alertas de validade e baixa quantidade de produtos. O objetivo é centralizar esses processos para aprimorar o controle de insumos e agenda.
- Kagun Tattoo - Dona do estúdio;
- Jeferson Kenedy - Professor da disciplina;
- Paulyne Jucá - Professora de PDS (Projeto Detalhado de Software);
- Diana Braga - Professora de GP (Gerência de Projetos);
- Lívia Almada - Professora de FBD (Fundamento de Banco de Dados);
- Danyel Granzotti - Membro da equipe;
- Jhordanna Gonçalves - Membro da equipe;
- João Bevilaqua - Membro da equipe;
- Kendriks da Paixão - Membro da equipe;
- Larissa Saraiva- Membro da equipe;
- Clientes do Estúdio;
- Fornecedores de produtos para o estúdio de tatuagem.
- Backend: Node.js, Express
- Frontend: Electron
- Banco de Dados: PostgressSQL
- Controle de Versão: Git
/backend: Código fonte do backend/frontend: Código fonte do frontend/docs: Documentação do projeto
- Clone o repositório.
- Navegue até o diretório
backende instale as dependências comnpm install. - Inicie o servidor backend com
npm start. - Navegue até o diretório
frontende instale as dependências comnpm install. - Inicie o servidor frontend com
npm start. - Acesse o sistema através do navegador em
http://localhost:3000.
Este projeto utiliza o GitFlow como metodologia de gerenciamento de branches e colaboração no desenvolvimento. Seguem as diretrizes para contribuir com o repositório:
Se certifique de que você está na versão mais recente da branch develop do repositório.
git pull origin develop
Faça o checkout da branch de desenvolvimento usando o comando git
git checkout develop
Crie uma nova branch para a sua tarefa com o comando
git checkout -b nome-da-branch
Onde "nome-da-branch" deve seguir o padrão "[tipo de task] - [descrição-curta]".
| tipo de task | palavra-chave |
|---|---|
| nova funcionalidade | feature |
| correção de bugs | fix |
| refatoração | refac |
Exemplo:
git checkout -b feature-login
Faça as alterações no código necessárias para completar a task e faça commits com mensagens descritivas e claras.
| tipo de commit | palavra-chave |
|---|---|
| commit inicial | init |
| documentação | docs |
| novo recurso | feature |
| teste | test |
| correção de bugs | fix |
| refatoração | refac |
Exemplo:
git commit -m "feat: implementar login"
Preferencialmente cada branch deve conter apenas um commit com todas as alterações necessárias para completar a task. Caso seja necessário fazer mais de um commit, faça commits atômicos, ou seja, cada commit deve conter alterações que façam sentido por si só.
Quando a task estiver completa e testada, faça um push da sua branch para o repositório remoto.
git push origin nome-da-branch
Faça o rebase da sua branch com a branch develop para garantir que ela está atualizada com as últimas alterações feitas na branch develop.
git fetch --all
git rebase origin/develop
Resolva os conflitos que possam surgir durante o rebase. Se você não souber como resolver os conflitos, peça ajuda a um membro da equipe.
Faça um push da sua branch atualizada para o repositório remoto.
git push origin nome-da-branch -f
Abra um merge request (MR) da branch criada para a branch develop. Para isso entre no repositório do github e navegue até o menu e Pull Requests e clique em New Pull Request.
Preencha o título e a descrição do PR com informações claras e objetivas sobre a task.
Adicione os membros que devem revisar o código como Reviewers.
Avise os membros da equipe que você abriu um PR para que eles possam revisar o código.