README.md

artezaria

Projeto de uma loja de compra e venda de artes em geral. Requisito parcial da disciplina de Introdução ao Desenvolvimento Web (SCC0219) do curso de Ciências de Computação do ICMC/USP durante o 1º semestre de 2022.

1. Requerimentos

• O sistema deve ter dois tipos gerais de usuários: clientes e administradores; clientes devem poder ativar a funcionalidade de artesão e se tornarem clientes artesãos:

  • Administradores são responsáveis por registrar e gerenciar administradores, clientes, e produtos ou serviços disponivilizados.

  • Clientes são usuários que acessam o sistema para comprar produtos.

  • Clientes artesãos são clientes que, tendo ativada a funcionalidade de artesão, acessam o sistema para anunciar produtos.

• O registro de administrador deve incluir, no mínimo, nome, id, e email.

• Cada registro de cliente deve incluir, no mínimo, nome, id, address e email.

• Quando um cliente ativar a opção de artesão, seu registro também deve incluir description.

• O registro de produtos deve incluir, no mínimo, id, title, image, description, price, quantity_in_stock e quantity_sold.

• A loja deve vender apenas produtos.

• Processo de venda de um produto: produtos são selecionados, incluídos no carrinho e têm suas quantidades escolhidas. Produtos são comprados usando um número de cartão de crédito (sem validação). A quantidade de produtos vendidos é subtraída da quantidade em estoque e adicionada à quantidade vendida. Os carrinhos são esvaziados apenas após o pagamento ou, então, pelos clientes.

• Manutenção de produtos

  • Administradores podem ler e deletar produtos.

  • Clientes artesãos podem criar, atualizar, ler e deletar seus próprios produtos.

• O sistema deve ter uma funcionalidade extra de valorização aos clientes artesãos da plataforma. Todos eles devem ter páginas dedicadas contando com descrição.

• O sistema deve prover recursos de acessibilidade e boa usabilidade.

2. Descrição do projeto

artezaria é uma plataforma de compra e venda de obras de arte, como quadros, artesanatos, esculturas, sendo eles de produção única ou em larga quantidade. O foco principal é no comércio dos produtos, mas, também, de valorização de artistas, suas artes e histórias.

2.1. Protótipo

O protótipo da plataforma foi implementado usando HTML, CSS, alguns componentes do Material Design e o carrossel do framework Owl Carousel 2 para a exibição dos produtos e os scripts necessários para o funcionamento dos elementos.

2.2. Versão final

A versão atual da plataforma, em produção, foi implementada usando os frameworks React e Node, MongoDB para armazenamento de dados, ideais de estilização do Material Design e a biblioteca Material UI, que implementa os componentes do Material Design. O protótipo se encontra na pasta prototipo e a versão final em artezaria.

2.3. Diagramas de navegação

Para organizar os conjuntos de telas, foram desenvolvidos diagramas de navegação para o cliente e administrador.

a. Diagrama do Cliente

b. Diagrama do administrador

Os mockups desenvolvidos para as páginas do cliente estão sob a pasta imagens/telas, na raiz do projeto, com nomes correspondentes aos itens dos diagramas de tela.

2.4. Funcionalidades propostas para o sistema

Através das telas propostas, os autores esperam que, através do sistema:

1. Um usuário qualquer possa entrar com e-mail e senha na plataforma, cadastrar-se e alterar informações sobre seu próprio cadastro, através das telas Entrar/Cadastrar e Perfil;

2. Um cliente possa visualizar, adicionar ao carrinho e comprar Produtos disponíveis no site, através das telas Tela Inicial, Produto, Carrinho e Pagamento;

3. Um cliente possa visualizar a página de descrição de artistas ativos na plataforma através da tela Artesão;

4. Um cliente possa se tornar um cliente artesão, gerenciar suas informações de artesão, seus anúncios ativos e vendas em processo, através das telas Perfil do artesão, Gerenciar vendas e Gerenciar anúncios;

5. Um administrador possa gerenciar o sistema, administradores, anúncios e usuários através das telas Dashboard, Gerenciar anúncios e Gerenciar usuários.

3. Comentários sobre o código

3.1. Protótipo

O código-fonte do protótipo está disposto sob a pasta prototipo. Nela, estão as pastas css, com os estilos desenvolvidos, pages, com as páginas desenvolvidas e os demais arquivos utilizados pelas ferramentas externas utilizadas.

3.2. Versão final

O código-fonte do protótipo está disposto sob a pasta artezaria. Nela, estão as pastas application, com o conteúdo do front-end em React.js e server, com o conteúdo do back-end em Node.js. O diretório src de application é dividido em:

• api: arquivos de integração com o servidor;
• domain: definição dos objetos utilizados (CreditCard, Product, PurchaseItem, Purchase e User);
• presentation:
  • components: componentes parciais utilizados nas telas;
  • context: contexto de aplicação de carrinho, gerenciamento, tema e usuário;
  • pages: páginas desenvolvidas;
  • routers: rotas para aplicação.
• Arquivos da aplicação.

O diretório src de server é dividido em:

• controller: arquivos de integração com o servidor;
• model: definição dos objetos utilizados (Purchase, Product, PurchaseItem e User);
• route: rotas para aplicação;
• util: arquivos úteis;
• Arquivos da aplicação.

4. Procedimentos de execução

4.1. Para o protótipo

Basta realizar o download do repositório, navegar até a pasta em que estão dispostos os protótipos desenvolvidos e abrir num navegador web.

4.2. Para a versão final

1. No Ubuntu, instale o npm;
2. Para construir projetos com nodemon, use npm install -g nodemon;
3. Para executar o projeto em Node, dentro da pasta server, instale as dependências com npm install e execute npm start;
4. Para construir projetos em React, use npm install create-react-app;
5. Para executar o projeto em React, dentro da pasta application, instale as dependências com npm install e execute npm start.

5. Plano de testes

5.1. Para o protótipo

O projeto foi executado apenas no navegador Google Chrome, sem problemas aparentes de execução. Quando houver a possibilidade de uso de frameworks e servidor, serão utilizadas as ferramentas adequadas para testes, como, por exemplo, JUnit e Postman.

5.2. Para a versão final

a. Cliente

Use, para exemplo, o usuário cliente1@cliente.com e senha cliente123

• Um cliente deve conseguir cadastrar-se e fazer login;
• Um cliente deve conseguir ver produtos publicados ao clicar em seus cards;
• Um cliente deve conseguir ver artistas ao clicar em seus nomes nos cards de produto;
• Um cliente, na página de produto, deve conseguir selecionar um produto para o carrinho;
• Um cliente, na página de carrinho, deve conseguir alterar a quantidade e remover seus produtos;
• Um cliente, no fluxo de compra, deve conseguir comprar seu carrinho;
• Um cliente, a partir da tela de edição de perfil, deve conseguir alterar seus dados ou se tornar um artesão.

b. Artesão

Use, para exemplo, o usuário vincent@vangogh.com e senha vincent123

• Um artesão deve conseguir, a partir de sua página de perfil, inserir sua descrição;
• Um artesão deve conseguir, a partir da página de anúncios, criar e visualizar seus anúncios;
• Um artesão deve conseguir, a partir da visualização de vendas de um anúncio, marcá-lo como enviado aos compradores.

c. Administrador

Use, para exemplo, o usuário admin1@admin.com e senha admin123

• Um administrador deve conseguir, a partir da tela de manutenção de anúncios, pesquisar, visualizar ou remover um anúncio;
• Um administrador deve conseguir, a partir da tela de manutenção de usuários, pesquisar, visualizar (se artesão), tornar administrador e excluir (se não for administrador) um usuário.

6. Problemas

• Construção dos protótipos iniciais: a intenção do grupo era utilizar os componentes (campos de texto, botões e cards) disponibilizados pelo Material Design. Isso não foi plenamente possível pois, para a implementação, seriam necessários arquivos de configuração personalizados externos aos .html e .css criados.

Autores

• Gustavo Henrique Brunelli (11801053)

• Matheus Henrique de Cerqueira Pinto (11911104)

• Matheus Ventura de Sousa (11345541)