{"id":15009328,"url":"https://github.com/robsonmt/minimarket-api","last_synced_at":"2026-01-19T02:32:32.377Z","repository":{"id":39824678,"uuid":"482857990","full_name":"RobsonMT/MiniMarket-API","owner":"RobsonMT","description":null,"archived":false,"fork":false,"pushed_at":"2023-05-01T23:42:22.000Z","size":212,"stargazers_count":1,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-04-05T01:45:11.367Z","etag":null,"topics":["migrations","postgresql","postgresql-database","python-3-6"],"latest_commit_sha":null,"homepage":"https://mini-market-api.herokuapp.com/api/users","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RobsonMT.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-04-18T13:31:53.000Z","updated_at":"2023-03-10T13:09:49.000Z","dependencies_parsed_at":"2022-08-28T06:20:31.060Z","dependency_job_id":null,"html_url":"https://github.com/RobsonMT/MiniMarket-API","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobsonMT%2FMiniMarket-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobsonMT%2FMiniMarket-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobsonMT%2FMiniMarket-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobsonMT%2FMiniMarket-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RobsonMT","download_url":"https://codeload.github.com/RobsonMT/MiniMarket-API/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247276098,"owners_count":20912287,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["migrations","postgresql","postgresql-database","python-3-6"],"created_at":"2024-09-24T19:24:33.641Z","updated_at":"2026-01-19T02:32:32.352Z","avatar_url":"https://github.com/RobsonMT.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MiniMarket-API\n\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/RobsonMT/MiniMarket-API\"\u003e\n    \u003cimg src=\"https://github.com/RobsonMT/MiniMarket-API/blob/feat/readme/assets/mmlogo.png?raw=true\" alt=\"Logo\" width=\"200\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003eMiniMarket API\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    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.\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"linkdovercel\"\u003e\u003cstrong\u003eExplore a aplicação no vercel.\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/RobsonMT/MiniMarket-API/issues\"\u003eReportar um bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/RobsonMT/MiniMarket-API/issues\"\u003eSugerir uma funcionalidade\u003c/a\u003e\n\n  \u003c/p\u003e\n\u003c/div\u003e\n\n## Visão geral\n\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#motivacao\"\u003eSobre o projeto\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#tecnologias\"\u003eTecnologias\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#instruções\"\u003eInstruções\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#instalação\"\u003eInstalação\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n    \u003ca href=\"#rotas\"\u003eRotas\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#AUTH\"\u003eAUTH\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#USERS\"\u003eUSERS\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#CLIENTS\"\u003eCLIENTS\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#ESTABLISHMENT\"\u003eESTABLISHMENT\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#PRODUCTS\"\u003ePRODUCTS\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#SALES\"\u003eSALES\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#sobre\"\u003eSobre\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\n## Tecnologias\n\nTecnologias utilizadas na construção dessa aplicação:\n\n- [Python](https://www.python.org/)\n- [Flask](https://flask.palletsprojects.com/en/2.1.x/)\n- [Flask SQLALchemy](https://flask-sqlalchemy.palletsprojects.com/en/2.x/)\n\n## Instruções\n\nEste é um guia de como configurar e rodar a aplicação localmente, siga os seguintes passos:\n\n### Instalação\n\nClone o repositório em sua máquina:\n\u003cbr /\u003e\n\nVia SSH:\n\u003cbr /\u003e\n\n`$ git clone git@github.com:RobsonMT/MiniMarket-API.git`\n\u003cbr /\u003e\n\nVia HTTPS:\n\u003cbr /\u003e\n\n`$ git clone https://github.com/RobsonMT/MiniMarket-API.git`\n\u003cbr /\u003e\n\nCrie um ambiente virtual (venv) para seus pacotes pelo comando:\n\u003cbr /\u003e\n\n`\u003cfilepath\u003e$ python -m venv venv`\n\u003cbr /\u003e\n\nAtive o venv pelo comando:\n\u003cbr /\u003e\n\n`$ source venv/bin/activate`\n\u003cbr /\u003e\n\nInstale os pacotes contidos no `requirements.txt` através do comando:\n\u003cbr /\u003e\n\n`$ pip install -r requirements.txt`\n\u003cbr /\u003e\n\n## Rotas\n\nAbaixo descritas as respectivas rotas presentes nessa aplicação.\n\n\u003cbr /\u003e\n\n## AUTH\n\nRotas de autenticação.\n\n## POST signup\n\nCria um novo usuário.\n\n`/api/signup`\n\u003cbr /\u003e\nBody (JSON):\n\u003cbr /\u003e\n\n```sh\n{\n  \"name\": \"marcelo\",\n  \"email\": \"marcelo@email.com\",\n  \"password\": \"123456\",\n  \"avatar\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/7/7c/User_font_awesome.svg/2048px-User_font_awesome.svg.png\",\n  \"contact\": \"19 93588-3611\"\n}\n```\n\n## POST signin\n\nLoga o usuário.\n\n`/api/signin`\n\u003cbr /\u003e\nBody (JSON):\n\u003cbr /\u003e\n\n```sh\n{\"email\": \"marcelo@email.com\",\n\"password\": \"123456\"}\n```\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n## USERS\n\nRotas de usuário.\n\n## GET users\n\nRetorna todos os usuários.\n\n`/api/users`\n\n## GET all users\n\nRetorna todos os usuários.\n\n`/api/users/all`\n\n## GET user by id\n\nRetorna todos os usuários.\n\n`/api/users/\u003cid\u003e`\n\n## PATCH user by id\n\nRetorna todos os usuários.\n\n`/api/users/\u003cid\u003e`\n\n```sh\n{\n  \"name\": \"Marcelo Menddes\"\n}\n```\n\n## PATCH change user state\n\nAltera o estado ativo/inativo\n\n`/api/users/changestate/\u003cid\u003e`\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n## CLIENTS\n\nRotas de clientes.\n\n## GET all clients\n\nRetorna todos os clientes do estabelecimento.\n\n`api/establishment/\u003cestablishment_id\u003e/client`\n\n## GET client id by establishment id\n\nRetorna UM cliente (id) do estabelecimento.\n\n`/establishment/\u003cestablishment_id\u003e/client/\u003cclient_id\u003e`\n\n## POST client\n\nCria um novo cliente.\n\n`/api/users/api/client\n\n```sh\n{\n  \"name\": \"Joséw Silva\",\n  \"avatar\": \"https://media.istockphoto.com/illustrations/client-prime-white-round-button-illustration-id873164974\",\n  \"contact\": \"(19)88d888-1111\",\n  \"pay_day\": 20,\n  \"establishment_id\": 3\n}\n\n```\n\n## PATCH client\n\nAtualiza o cliente do estabelecimento.\n\n`/establishment/\u003cestablishment_id\u003e/client/\u003cclient_id\u003e`\n\nBODY:\n\n```sh\n{\n  \"name\": \"Hamero\"\n}\n```\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n## ESTABLISHMENT\n\nRotas de estabelecimento.\n\n## POST establishment\n\nCria um novo estabelecimento.\n\n`/api/establishments/user/\u003cint:user_id\u003e`\n\n## GET all establishments\n\nRetorna todos os estabelecimentos do usuário.\n\n`/api/establishments`\n\n## GET one establishment\n\nRetorna o estabelecimento do usuário pelo id do estabelecimento.\n\n`/api/establishments/\u003cint:id\u003e`\n\n## GET establishment by name\n\nRetorna o estabelecimento do usuário pelo id do estabelecimento.\n\n`/api/establishments/name/\u003cname\u003e`\n\n## PATCH establishment\n\nAtualiza o estabelecimento\n\n`/api/establishments/\u003cint:id\u003e`\n\n```sh\n    {\n    \"name\": \"Mercearia\",\n    \"url_logo\": \"\"\n    }\n```\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n## PRODUCTS\n\nRota de produtos.\n\n## POST\n\nCria um novo produto no estabelecimento.\n\n`/api/establishments/products`\n\n```sh\n{\n\"name\": \"Batata\",\n\"description\": \"batata frita\",\n\"sale_price\": 12,\n \"cost_price\":8,\n \"unit_type\":\"kg\",\n \"url_img\": \"feerergerg\",\n \"establieshment_id\":3,\n \"categories\": []\n}\n```\n\n## GET products\n\nRetorna os produtos do estabelecimento (id).\n\n`/api/establishments/\u003cestablishment_id\u003e/products`\n\n## GET product by id\n\nRetorna o produto (id) do estabelecimento\n\n`/api/establishments/\u003cestablishment_id\u003e/products/\u003cproduct_id\u003e`\n\n## GET product query\n\nRetorna o produto pesquisado.\n\n`/api/establishments/\u003cestablishment_id\u003e/products/query`\n\n## PATCH product\n\nAtualiza o produto do estabelecimento.\n\n`/api/establishments/\u003cestablishment_id\u003e/products/\u003cproduct_id\u003e`\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n## SALES\n\nRota de vendas.\n\n## GET sale\n\nRetorna a venda por id.\n\n`/api/sales/\u003cid\u003e`\n\n## GET sale by client\n\nRetorna a venda por cliente\n\n`/api/sales/client/\u003cclient_id\u003e`\n\n## POST sale\n\nCria nova venda.\n\n`/api/sales`\n\n```sh\n{\n\t\"paid_date\": \"25/06/2022\",\n\t\"client_id\":1,\n\t\"payment_id\":1,\n\t\"sale_total\":2000,\n\t\"remain_to_pay\": 2000\n}\n```\n\n## PATCH sale\n\nAtualiza a venda (id).\n\n`/api/sales/\u003cint:id\u003e`\n\n## Sobre\n\nEste projeto foi desenvolvido por:\n\nBruno de Lacerda Tetzner - [@brunotetzner](https://github.com/brunotetzner)\n\nJulio Pereira- [@ElBulidur](https://github.com/ElBulidur)\n\nRobson Martins - [@RobsonMT](https://github.com/RobsonMT)\n\nGabriel Amaral - [@Gabriel-dsAmaral](https://github.com/Gabriel-dsAmaral)\n\nRhamon de Souza - [@rhamo1](https://github.com/rhamo1)\n\nRafael Monteiro de Oliveira - [@raf2019](https://github.com/raf2019)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobsonmt%2Fminimarket-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobsonmt%2Fminimarket-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobsonmt%2Fminimarket-api/lists"}