Pizzaria-API-REST

API para Pizzaria utilizando Django Rest Framework.

Pizzaria-API-REST tem por objetivo facilitar o cadastro de clientes e o controle dos pedido de pizzas realizados. Projeto desenvolvido para avaliação da disciplina de programação para a internet 2, ministrada por Ely da Silva Miranda.

Devs

John Emerson

PedroHenrique

Apresentação

Clique no link para assistir o vídeo no YouTube, Apresentação do projeto.

Requisitos

• Django==2.2.5
• djangorestframework==3.10.3
• django-rest-swagger==2.2.0
• django-crispy-forms==1.8.1
• django-filter==2.2.0
• djangorestframework-simplejwt==4.3.0

Acompanhe a apresentação do desenvolvimento com o sistema rodando no seu computador.

Antes de iniciar a instalação certifique-se de que possui o python>=3.5 instalado no seu computador.

Instalação da aplicação

• Faça o clone ou o download do projeto do github no seu computador.
• instale os requerimentos necessários para rodar a aplicação com o comando: pip install -r requirements.txt
• realize as migrações com o comando: python manage.py migrate
• e finalmente inicialize o servidor com o comando: python manage.py runserver

Sobre o desenvolvimento

O desenvolvimento do projeto foi realizado em dupla, os envolvidos são: John Emerson e Pedro Henrique.

• Organização no desenvolvimento
  • Trello: Para facilitar o desenvolvimento das funcionalidades, utilizamos o trello, dessa forma podemos verificar o que precisa ser feito, o que está sendo feito e o que já foi concluído.
• Conventional commits
  • O conventional commits facilita o entendimento do que cada commit significa, forçando os colaboradores do projeto a descrever da melhor forma possível o que foi desenvolvido no commit em questão.
  • Acompanhe com mais detalhes o funcionamento do conventional commits, na parte final dessa leitura.

Modelagem do projeto

Address {
	"street": "",
    	"suite": "",
    	"city": "",
    	"zipcode": ""
}

Client {
	"name": "",
	"email": "",
	"phone": "",
	"address": Address()
}

Manager {
	"name": "",
	"cpf": "",
	"salary": 0.0,
	"email": ""
}

Employee {
	"name": "",
	"cpf": "",
	"salary": 0.0,
	"email": "",
	"manager": manager()
}

Progress {
	"name": ""
}

Pizza {
	"name": "",
	"description": "",
	"price": 0.0
}

Demand {
	"created": 00-00-0000,
	"client": Client(),
	"employee": Employee(),
	"pizza": Pizza(),
	"progress": Progress()
}

Endpoints disponíveis

uri	Funcionalidade
www.hostname.exemplo/user	Listagem e cadastro de usuários
www.hostname.exemplo/user/1	acesso aos dados de um usuários específico
	atualização e exclusão de dados de acordo com o ID passado
www.hostname.exemplo/address/	Listagem e cadastro de endereços
www.hostname.exemplo/address/1	acesso aos dados de um endereço específico
	atualização e exclusão de dados de acordo com o ID passado
www.hostname.exemplo/client/	Listagem e cadastro de clientes
www.hostname.exemplo/client/1	acesso aos dados de um cliente específico
	atualização e exclusão de dados de acordo com o ID passado
www.hostname.exemplo/manager/	Listagem e cadastro de gerentes
www.hostname.exemplo/manager/1	acesso aos dados de um gerente específico
	atualização e exclusão de dados de acordo com o ID passado
www.hostname.exemplo/employee/	Listagem e cadastro de funcionários
www.hostname.exemplo/employee/1	acesso aos dados de um funcionário específico
	atualização e exclusão de dados de acordo com o ID passado
www.hostname.exemplo/progress/	Listagem e cadastro de progressos
www.hostname.exemplo/progress/1	acesso aos dados de um progresso específico
	atualização e exclusão de dados de acordo com o ID passado
www.hostname.exemplo/pizza/	Listagem e cadastro de pizzas
www.hostname.exemplo/pizza/1	acesso aos dados de um pizza específica
	atualização e exclusão de dados de acordo com o ID passado
www.hostname.exemplo/demand/	Listagem e cadastro de pedidos
www.hostname.exemplo/demand/1	acesso aos dados de um pedido específico
	atualização e exclusão de dados de acordo com o ID passado
www.hostname.exemplo/manager-employees/	Listagem de todos os gerentes e dos funcionários subordinados ao mesmo
www.hostname.exemplo/employee-demands/	Listagem de todos os funcionários e da quantidade de pedidos recebidos
www.hostname.exemplo/client-demands/	Listagem de todos os clientes, total de pedidos e lista de pedidos
www.hostname.exemplo/client-demands/1	Listagem de todos os pedidos de um cliente especícifico
www.hostname.exemplo/api-auth//	Login baseado em sessão
www.hostname.exemplo/api/token/	Login baseado em token JWT (JSON Web Token)
www.hostname.exemplo/api/token/refresh/	Atualiza token JWT

Funcionalidades

1. Funcionário gerencia clientes
2. Gerente gerencia funcionários e clientes
3. Funcionário e gerente pode criar pedidos
4. Funcionário e gerente altera o andamento do pedido
5. Somente o gerente pode criar sabores de pizzas, porém todos podem ter acesso as pizzas cadastradas
6. geração de relatórios
   1. Gerente visualiza lista de funcionários subordinados
   2. Gerente visualiza total de pedidos atendidos por funcionários subordinados
   3. Gerente visualiza lista de pedidos realizados por clientes
   4. Gerente visualiza lista de pedidos de um cliente específico

Conventional commits

• chore: add Oyster build script // Pequenas alterações que não são novas funcionalidades.
• docs: explain hat wobble // Semelhante a uma wiki; documentações etc.
• feat: add beta sequence // Criação de Nova funcionalidade;
• fix: remove error message // Correção de bugs
• refactor: share logic 4d3d3d3 // Refatoração de um código
• style: convert tabs to spaces // Alteração em estilos, formatação de código etc.
• test: ensure that increment // Criação de testes da sua aplicação

A mensagem do seu commit deve possuir até 7 palavras; A descrição deve estar em inglês, em prol de objetividade; O tempo verbal da mensagem deve estar no presente; A mensagem tem que ser objetiva e rígida;