Repositório criado para armazenar os códigos do projeto Supermercado SQ, proposto no Atlântico Academy Bootcamp Fullstack oferecido pelo Instituto Atlântico.
O projeto do backend está disponível no link: https://supermercado-athena.herokuapp.com/
Para consultar as rotas disponíveis, consulte a documentação: https://supermercado-athena.herokuapp.com/docs/
- Sobre o Projeto
- Instalação do backend
- Instalação do frontend
- Elicitação dos Requisitos
- Atores do Sistema
- Modelagem da Visão Gerão
- Telas identificadas para o sistema
- Modelo de Dados - Conceitual
- Modelo de Dados - Lógico
- Planejamento
- Equipe
Clone este repositório usando o comando:
git clone https://github.com/Athena-Atlantico-Bootcamp/Supermercado-SQ.git
Entrar na pasta backend utilizando o comando:
cd backend
Instale as dependências com o comando:
npm i
Crie um arquivo .env e preencha conforme o arquivo exemplo .env.exemplo. Em DATABASE_URL, digite a string de conexão com o banco de dados. Em SECRET, escolha uma palavra para encriptar o JWT.
Para rodar no seu localhost utilize no terminal:
npm run dev
O projeto ficará disponível na porta http://localhost:3001/
Clone este repositório usando o comando:
git clone https://github.com/Athena-Atlantico-Bootcamp/Supermercado-SQ.git
Entrar na pasta backend utilizando o comando:
cd frontend
Instale as dependências com o comando:
npm i
Para rodar no seu localhost utilize no terminal:
npm run dev
O projeto ficará disponível na porta http://localhost:3000/
O supermercado SQ necessita de um sistema de gerenciamento de alimentos e composições alimentares.
Esse sistema poderá ser acessado pelos administradores do SQ, pelos fornecedores e pelos clientes.
O usuário poderá cadastrar produtos industrializados fornecendo quais ingredientes tem em sua composição. Dessa forma, em outros momentos será fácil pesquisar e confirmar se um produto contém ou não determinado ingrediente utilizando essa aplicação. Podendo até ser escalado o seu uso para usuários globais, como uma espécie de comunidade.
- Possibilidade de cadastrar, visualizar, editar e deletar produtos (utilizando banco de dados)
- O produto deve ter nome e conter seus ingredientes, imagem (opcional)
- Possibilidade de pesquisar por alimentos e visualizar os ingredientes
- Na página de visualização do alimento, ter a possibilidade de buscar por um determinado ingrediente (para confirmar se este ingrediente está presente ou não)
- Possibilidade de filtrar alimentos que não tenham determinados ingredientes
- Possibilidade de filtrar alimentos que tenham determinados ingredientes
| Tipo de usuário | Permissões |
|---|---|
| Administradores | Visualizar, criar, editar e deletar produtos, comentários e usuários |
| Fornecedores | Visualizar produtos e comentários; Criar produtos e comentários; Editar e deletar produtos e comentários inseridos por eles mesmos. Produtos criados por fornecedores recebem uma indicação de "Produto verificado" |
| Clientes cadastrados | Visualizar e criar produtos e comentários; Editar e deletar produtos e comentários inseridos por eles mesmos |
| Visitantes | Visualizar produtos e comentários |
Telas de Baixa
-
Preview:
-
Projeto Figma disponível [neste link.]
Telas Finais
- Projeto Figma disponível [neste link.]
Entrega 1 - Camada de dados
| Feature | Stories | Tasks | Responsáveis | Prazo |
|---|---|---|---|---|
| Organizar o Squad | Divisão de tarefas dentro do time | Falar sobre seus interesses | Todos | 04/22 |
| Listar suas skills | Todos | 04/22 | ||
| Planejamento preliminar | Fazer um brainstorming de ideias sobre o projeto | Todos | 04/22 | |
| Listar e dividir as tarefas e responsabilidades | Todos | 04/22 | ||
| Decidir dia e horário da reunião semanal | Todos | 04/22 | ||
| Camada de Dados | Modelagem de dados | Realizar a modelagem conceitual | Ada* | 19/05/2022 |
| Realizar a modelagem lógica | Ada* | 19/05/2022 | ||
| Modelagem de Caso de Uso | Realizar a modelagem de caso de uso | Luiza* | 19/05/2022 | |
| Revisão | Revisar as modelagens com a professora / monitores | Todos | 18/05/2022 | |
| Banco de dados | Decidir qual BD vamos utilizar | Todos | 30/04/2022 | |
| Criar o banco de dados | Anderson* | 19/05/2022 | ||
| Entrega 01 | Realizar entrega 01 - Módulo Inicial | Entregar Camada de dados | Luiza | 21/05/2022 |
| Entregar o projeto de implementação / divisão das atividades | Luiza / Beatriz | 21/05/2022 |
Entrega 2 - Backend
| Feature | Stories | Tasks | Responsáveis | Prazo |
|---|---|---|---|---|
| Backend | Escolher a tecnologia backend | Discutir e decidir em grupo | Todos | 22/05/2022 |
| Models component | Implementar o models component | Beatriz* | 05/06/2022 | |
| CRUD Usuários | Implementar o CRUD de usuários (rotas e controllers) | Beatriz / Anderson | 05/06/2022 | |
| CRUD Produtos | Implementar o CRUD de produtos (rotas e controllers) | Luiza | 07/06/2022 | |
| CRUD Comentários | Implementar o CRUD de comentários (rotas e controllers) | Ada / Leonardo / Lucas / João | 12/06/2022 | |
| Conectar backend com o banco de dados e testar conexão | Implementar a conexão string para base de dados | Todos | 17/06/2022 | |
| Testar a conexão usando o Insomnia | Todos | 17/06/2022 | ||
| Login e autenticação | Implementar autenticação com JWT e Bcrypt | Luiza* | 14/06/2022 | |
| Documentação da API | Documentação das rotas e schemas através do Swagger | Beatriz / Luiza | 17/06/2022 | |
| Deploy do Banco de Dados | Deploy através do Heroku | Lucas* | 16/06/2022 | |
| Deploy da API | Deploy através do Heroku | João* | 17/06/2022 | |
| Entrega 02 | Realizar entrega 02 - Módulo Intermediário | Entregar API testada e funcional (requisições) através de um repositório no GitHub | Luiza | 17/06/2022 |
Entrega 3 - Frontend
| Feature | Stories | Tasks | Responsáveis | Prazo |
|---|---|---|---|---|
| Frontend | Escolher um template | Pesquisar sites de mercados e/ou lojas de produtos sem glúten, sem lactose... | Beatriz | 15/05/2022 |
| Votar no template a ser seguido | Todos | 15/05/2022 | ||
| Prototipagem | Prototipagem no Figma | Luiza | 24/05/2022 | |
| Escolher a tecnologia frontend | Discutir e decidir em grupo | Todos | 24/06/2022 | |
| Rotas | Organizar as pastas das páginas | Luiza | 24/06/2022 | |
| Crias as rotas do React com react-rouder-dom | Lucas* | 24/06/2022 | ||
| AXIOS | Implementar o AXIOS e testas rotas | Beatriz* | 24/06/2022 | |
| Preparação backend | Melhorias do backend | Ada* | 05/07/2022 | |
| Subir as mudanças no heroku | João | 05/07/2022 | ||
| Componentes Principais | Footer | Luiza | 05/07/2022 | |
| Botões | João | 05/07/2022 | ||
| Card Produto | Ada/Leonardo | 05/07/2022 | ||
| Header | Beatriz/Paulo | 11/07/2022 | ||
| Modais | João/Lucas | 13/07/2022 | ||
| Páginas Responsivas | Home | Luiza | 11/07/2022 | |
| Login | Lucas | 11/07/2022 | ||
| Sobre Nós | Luiza | 11/07/2022 | ||
| Alergias Alimentares | Luiza | 13/07/2022 | ||
| Buscar | Luiza | 13/07/2022 | ||
| Página Produto | Beatriz/Paulo | 13/07/2022 | ||
| Perfil Administrador | Ada/Leonardo | 13/07/2022 | ||
| Perfil Usuário | Ada/Leonardo | 13/07/2022 | ||
| Integração Front + Back | Integrar Pág. Home | GET Produtos | Luiza | 11/07/2022 |
| Integrar Pág. Buscar | GET Produtos com e sem ingredientes | Luiza | 13/07/2022 | |
| Integrar Pág. Produto | GET Produto | Paulo | 13/07/2022 | |
| CRUD Comentários | Paulo | 13/07/2022 | ||
| Integrar Pág. Login | POST Usuários | João/Luiza | 11/07/2022 | |
| LOGIN Usuários | João/Luiza | 11/07/2022 | ||
| Integrar Pág. Perfil Usuários | CRUD Usuários | Ada/João | 16/07/2022 | |
| CRUD Produtos | Ada/João | 16/07/2022 | ||
| Integrar Pág. Perfil Administrador | CRUD Usuários | João | 16/07/2022 | |
| CRUD Produtos | João | 16/07/2022 | ||
| Deploy | Deploy através da Vercel | - | 20/07/2022 | |
| Entrega 03 | Realizar entrega 03 - Módulo avançado | Entregar sistema completo, integrado aos módulos backend e camada de dados, implementado, funcional e testado | Luiza* | 16/07/2022 |
| Entrega Final | Demoday | Preparar apresentação | - | 23/07/2022 |
| Apresentar o projeto | - | 23/07/2022 |
Obs.: Nomes marcados com * indicam que a atividade foi realizada em grupo e a pessoa estava compartilhando a tela.
Equipe de desenvolvimento: Squad 3 - Athena
Ada 💜 |
Beatriz 🤓 |
João Victor 😎 |
Leonardo 😃 |
Lucas 😸 |
Luiza 🌟 |
Anderson 🌌 |