Skip to content

CtrI-Alt-Del/stocker

Repository files navigation

Stocker 📦

Stocker

Visão geral do produto 🖥️

Stocker é uma aplicação que visa facilitar o gerenciamento de estoque, oferecendo funcionalidades de controle (adição, edição e remoção) de produtos armazenados, assim como a visualização e acompanhamento das quantidades e detalhes dos itens em estoque. O sistema oferece uma interface simples e eficiente para monitorar o inventário de qualquer tipo de negócio ou armazém.


Problema do cliente 👔

Atualmente, muitas empresas enfrentam desafios significativos no gerenciamento de estoque devido ao uso de métodos manuais, como planilhas ou papel. Esses métodos antiquados resultam em problemas como dificuldade de atualização em tempo real, erros manuais, falta de visibilidade sobre a quantidade de produtos disponíveis e dificuldades na reposição de itens. A ausência de um sistema centralizado também impede a análise rápida e precisa das informações do inventário, o que pode prejudicar a tomada de decisões estratégicas. A complexidade e a falta de eficiência desses métodos manuais podem levar a perdas financeiras e a uma má reputação da empresa. Portanto, é crucial para as empresas modernizar seus processos de gerenciamento de estoque e adotar soluções tecnológicas mais eficientes e confiáveis.


Objetivo do produto 🎯

A aplicação tem como objetivo automatizar o controle de estoque, permitindo o gerenciamento de produtos de forma eficiente e acessível. Os usuários poderão adicionar, editar e remover itens do estoque, com controle de permissões para garantir que apenas administradores possam realizar essas ações críticas. A interface intuitiva permite o acompanhamento em tempo real da situação do estoque, melhorando a gestão de inventários e facilitando a reposição de produtos. O sistema será acessível de qualquer lugar, permitindo que os usuários acompanhem e gerenciem o estoque remotamente.


Metodologia empregada 💡

Para a confecção do produto foi empregado o framework de metodologia ágil Scrum, que consiste sumariamente dividir o desenvolvimento do projeto em Sprints, um conjunto de tarefas que devem ser executadas e desenvolvidas em um período pré-definido de tempo. Além disso, foi definido o Backlog do Produto, que são todas as funcionalidades que o software deverá ter com base nos requisitos levantados com o cliente. Uma vez aprovado por ele, para selecionar quais seriam as entregas das Sprints do projeto, primeiro foi definido o MVP de cada Sprint, que é uma versão do produto que prioriza as tarefas que trazem maior entrega de valor para o cliente. Então, a partir disso o Backlog do Produto foi dividido em 4 Backlog de Sprint.


MVP'S 🏆

Redirecionamento para o Drive

Para acessar os MVP's, acesse o link: clique aqui.


Backlog do produto 📖

Requisitos 📒

Tabela contendo todos os requisitos em ordem de prioridade

Histórias de usuário 🃏

Primeira parte da tabela que contém todos as histórias de usuário Segunda parte da tabela que contém todos as histórias de usuário


Relatório e detalhes de cada Sprint 📅


Tecnologias 🛠️

Figma Figma TailwindCSS TailwindCSS TypeScript TypeScript React React NodeJS NodeJS NextJS NextJS Fastify Fastify NextUi NextUI prisma Prisma zod Zod nuqs Nuqs supabase Supabase

Como Executar Localmente no Windows 🖥️

Pré-requisitos

Antes de começar, certifique-se de que você tem o seguinte instalado em sua máquina Windows:

  1. Node.js: Baixe e instale o Node.js a partir de nodejs.org. Isso também instalará o npm (Node Package Manager).
  2. Git: Baixe e instale o Git a partir de git-scm.com.
  3. Um editor de código: Você pode usar qualquer editor de código, mas o Visual Studio Code é recomendado. Baixe-o em code.visualstudio.com.

Passo 1: Clonar o Repositório

Abra o seu prompt de comando (cmd) ou PowerShell e execute o seguinte comando para clonar o repositório:

git clone https://github.com/CtrI-Alt-Del/stocker

Passo 2: Navegar até o Diretório do Projeto

Mude para o diretório do projeto:

cd stocker

Passo 3: Instalar Dependências

Execute o seguinte comando para instalar as dependências necessárias:

npm install

Passo 4: Configurar Variáveis de Ambiente do SERVIDOR e do CLIENTE:

  1. Localize o arquivo .env.example na raiz do seu diretório do projeto. Este arquivo contém exemplos de variáveis de ambiente que você precisa configurar.
  2. Crie um novo arquivo chamado .env no mesmo diretório que o .env.example.
  3. Copie o conteúdo do .env.example para o novo arquivo .env.
  4. Atualize os valores no arquivo .env de acordo com sua configuração local. Aqui está um exemplo de como o arquivo .env pode parecer:

Variáveis de Ambiente do SERVIDOR:

PORT=3333
MODE=development
DATABASE_URL=sua_url_do_banco_de_dados
DIRECT_URL=sua_url_direta
SUPABASE_URL=sua_url_supabase
SUPABASE_KEY=sua_chave_supabase

Variáveis de Ambiente do CLIENTE:

NEXT_PUBLIC_APP_URL=http://localhost:3000
NEXT_PUBLIC_SERVER_URL=http://localhost:3333

Certifique-se de substituir os valores de espaço reservado pelos seus dados reais.

Passo 5: Executar o Projeto

Após configurar as variáveis de ambiente, você pode executar o projeto usando o seguinte comando na pasta stocker:

npm run dev

Este comando iniciará a aplicação, e você deverá ver uma saída indicando que a aplicação cliente e servidor está em execução.

Passo 6: Acessar a Aplicação

Abra seu navegador e navegue até http://localhost:3000 (ou a porta que você especificou no arquivo .env) para acessar a aplicação web. Ou abra o navegador e navegue até http://localhost:3333 (ou a porta que você especificou no arquivo .env) para acessar o servidor.

Solução de Problemas

  • Se você encontrar algum problema, verifique a saída do console para mensagens de erro.
  • Certifique-se de que todas as variáveis de ambiente estão configuradas corretamente no arquivo .env tanto do cliente quanto do servidor.
  • Verifique se seu banco de dados e quaisquer outros serviços estão em execução, caso sua aplicação dependa deles.

🚧Caso haja algum erro ao executar as dependências do projeto, rode o comando npm install na pasta apps/server e apps/web separadamente e tente executar o projeto novamente.🚧


Time de Desenvolvimento 👷🏻

Foto Nome Função Github Linkedin
Joao Pedro Carvalho Product Owner
Thiago Martins Scrum Master
Kauan Fonseca do Vale Scrum Team
Rafael dos Santos Scrum Team
Gabriel Oliveira Scrum Team
Joao Gabriel Oliveira Scrum Team

About

Aplicação web visada para gestão de estoque.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages