MiniMarket API

Uma API voltada para a gestão de pequenos comércios, focada em agilizar a organização dos pagamentos e a gestão dos clientes.


Explore a aplicação no vercel.

Reportar um bug · Sugerir uma funcionalidade

1. Sobre o projeto
   • Tecnologias
2. Instruções
   • Instalação
3. Rotas
   • AUTH
   • USERS
   • CLIENTS
   • ESTABLISHMENT
   • PRODUCTS
   • SALES
4. Sobre

Tecnologias utilizadas na construção dessa aplicação:

• Python
• Flask
• Flask SQLALchemy

Este é um guia de como configurar e rodar a aplicação localmente, siga os seguintes passos:

Clone o repositório em sua máquina:

Via SSH:

$ git clone [email protected]:RobsonMT/MiniMarket-API.git

Via HTTPS:

$ git clone https://github.com/RobsonMT/MiniMarket-API.git

Crie um ambiente virtual (venv) para seus pacotes pelo comando:

<filepath>$ python -m venv venv

Ative o venv pelo comando:

$ source venv/bin/activate

Instale os pacotes contidos no requirements.txt através do comando:

$ pip install -r requirements.txt

Abaixo descritas as respectivas rotas presentes nessa aplicação.

Rotas de autenticação.

Cria um novo usuário.

/api/signup
Body (JSON):

{
  "name": "marcelo",
  "email": "[email protected]",
  "password": "123456",
  "avatar": "https://upload.wikimedia.org/wikipedia/commons/thumb/7/7c/User_font_awesome.svg/2048px-User_font_awesome.svg.png",
  "contact": "19 93588-3611"
}

Loga o usuário.

/api/signin
Body (JSON):

{"email": "[email protected]",
"password": "123456"}

Rotas de usuário.

Retorna todos os usuários.

/api/users

Retorna todos os usuários.

/api/users/all

Retorna todos os usuários.

/api/users/<id>

Retorna todos os usuários.

/api/users/<id>

{
  "name": "Marcelo Menddes"
}

Altera o estado ativo/inativo

/api/users/changestate/<id>

Rotas de clientes.

Retorna todos os clientes do estabelecimento.

api/establishment/<establishment_id>/client

Retorna UM cliente (id) do estabelecimento.

/establishment/<establishment_id>/client/<client_id>

Cria um novo cliente.

`/api/users/api/client

{
  "name": "Joséw Silva",
  "avatar": "https://media.istockphoto.com/illustrations/client-prime-white-round-button-illustration-id873164974",
  "contact": "(19)88d888-1111",
  "pay_day": 20,
  "establishment_id": 3
}

Atualiza o cliente do estabelecimento.

/establishment/<establishment_id>/client/<client_id>

BODY:

{
  "name": "Hamero"
}

Rotas de estabelecimento.

Cria um novo estabelecimento.

/api/establishments/user/<int:user_id>

Retorna todos os estabelecimentos do usuário.

/api/establishments

Retorna o estabelecimento do usuário pelo id do estabelecimento.

/api/establishments/<int:id>

Retorna o estabelecimento do usuário pelo id do estabelecimento.

/api/establishments/name/<name>

Atualiza o estabelecimento

/api/establishments/<int:id>

    {
    "name": "Mercearia",
    "url_logo": ""
    }

Rota de produtos.

Cria um novo produto no estabelecimento.

/api/establishments/products

{
"name": "Batata",
"description": "batata frita",
"sale_price": 12,
 "cost_price":8,
 "unit_type":"kg",
 "url_img": "feerergerg",
 "establieshment_id":3,
 "categories": []
}

Retorna os produtos do estabelecimento (id).

/api/establishments/<establishment_id>/products

Retorna o produto (id) do estabelecimento

/api/establishments/<establishment_id>/products/<product_id>

Retorna o produto pesquisado.

/api/establishments/<establishment_id>/products/query

Atualiza o produto do estabelecimento.

/api/establishments/<establishment_id>/products/<product_id>

Rota de vendas.

Retorna a venda por id.

/api/sales/<id>

Retorna a venda por cliente

/api/sales/client/<client_id>

Cria nova venda.

/api/sales

{
	"paid_date": "25/06/2022",
	"client_id":1,
	"payment_id":1,
	"sale_total":2000,
	"remain_to_pay": 2000
}

Atualiza a venda (id).

/api/sales/<int:id>

Este projeto foi desenvolvido por:

Bruno de Lacerda Tetzner - @brunotetzner

Julio Pereira- @ElBulidur

Robson Martins - @RobsonMT

Gabriel Amaral - @Gabriel-dsAmaral

Rhamon de Souza - @rhamo1

Rafael Monteiro de Oliveira - @raf2019

(back to top)