{"id":18429818,"url":"https://github.com/sartim/flask_shop_api","last_synced_at":"2025-06-23T20:06:37.314Z","repository":{"id":48289513,"uuid":"176507271","full_name":"sartim/flask_shop_api","owner":"sartim","description":"REST API for an online shop developed using flask framework which runs as a websocket server using socketio.","archived":false,"fork":false,"pushed_at":"2024-03-03T19:33:20.000Z","size":994,"stargazers_count":2,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-07T17:41:59.431Z","etag":null,"topics":["flask","python3","rest-api","socketio-server"],"latest_commit_sha":null,"homepage":"https://flask-shop-api.vercel.app","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sartim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-19T12:28:44.000Z","updated_at":"2024-02-28T15:26:08.000Z","dependencies_parsed_at":"2023-02-14T09:46:08.503Z","dependency_job_id":"3a0d9110-cb09-498c-b58d-a2f26a8b5e12","html_url":"https://github.com/sartim/flask_shop_api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sartim/flask_shop_api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sartim%2Fflask_shop_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sartim%2Fflask_shop_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sartim%2Fflask_shop_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sartim%2Fflask_shop_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sartim","download_url":"https://codeload.github.com/sartim/flask_shop_api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sartim%2Fflask_shop_api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261548736,"owners_count":23175495,"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":["flask","python3","rest-api","socketio-server"],"created_at":"2024-11-06T05:18:44.596Z","updated_at":"2025-06-23T20:06:37.279Z","avatar_url":"https://github.com/sartim.png","language":"Python","readme":"# Flask Shop API\n\n[![Language](https://img.shields.io/badge/language-python-green.svg)](https://github.com/sartim/flask_shop_api)\n![build](https://github.com/sartim/flask_shop_api/workflows/build/badge.svg)\n\nREST API which exposes endpoints both for an online shop and a CMS admin. It's developed using flask framework which runs as a socketio server.\n\n##Features\n\n* RBAC\n* API Caching (Redis)\n* Fulltext search (Elasticsearch)\n\n## Setup\n\n**Requirements**\n\n* Python 3+\n* Virtualenv\n* Heroku CLI\n\n\n**Create virtual environment \u0026 install requirements**\n\n    $ virtualenv \u003cenvname\u003e -p python3\n    $ source \u003cenvname\u003e/bin/activate\n    $ pip install -r requirements.txt\n\n**Make migrations**\n\n    $ python manage.py db init\n    $ python manage.py db migrate\n    $ python manage.py db upgrade\n\n**Add dotenv to project root**\n\nYou should create a .env file on the project root using the following format:\n\nWhen using PostgreSQL DB_URL\n\n    DEV=TRUE\n    TEST=FALSE\n    PROD=FALSE\n    DATABASE_URL={DB_URL}\n    SECRET_KEY={SECRET}\n    PAGINATE_BY=20\n    ADMIN_EMAIL={EMAIL}\n    APP_EMAIL={EMAIL}\n    APP_EMAIL_PASSWORD={PASSWORD}\n    LOG_LEVEL=DEBUG\n\nWhen using sqlite for test\n\n    DEV=FALSE\n    TEST=TRUE\n    PROD=FALSE\n    SECRET_KEY=my_precious\n    PAGINATE_BY=20\n    ADMIN_EMAIL=admin@mail.com\n    APP_EMAIL=app@email.com\n    APP_EMAIL_PASSWORD=letmein\n    LOG_LEVEL=DEBUG\n    \n**Running app using manage.py**\n\n    $ python manage.py run\n\n**Running app using gunicorn**\n\n    $ gunicorn --worker-class eventlet -w 1 -b 0.0.0.0:8000 --timeout 300 wsgi:app\n    \n**Building \u0026 running on docker**\n\n    $ docker build --build-arg ENV=PROD --build-arg PAGINATE_BY=20 --build-arg CACHED_QUERY=CACHED_QUERY --build-arg REDIS_EXPIRE=3600 --build-arg SECRET_KEY=my_secret --build-arg REDIS_URL=redis://host:port --build-arg DATABASE_URL=postgresql://username:password@hostname:5432/database --build-arg ADMIN_EMAIL=test@mail.com --build-arg APP_EMAIL=test@email.com --build-arg APP_EMAIL_PASSWORD=password --build-arg LOG_LEVEL=ERROR -t flask-shop-api:latest .\n    $ docker run -p 8000:8000 flask-shop-api\n\n\n**Building \u0026 running on k8**\n\n    $ docker build --build-arg ENV=PROD --build-arg PAGINATE_BY=20 --build-arg CACHED_QUERY=CACHED_QUERY --build-arg REDIS_EXPIRE=3600 --build-arg SECRET_KEY=my_secret --build-arg REDIS_URL=redis://host:port --build-arg DATABASE_URL=postgresql://username:password@hostname:5432/database --build-arg ADMIN_EMAIL=test@mail.com --build-arg APP_EMAIL=test@email.com --build-arg APP_EMAIL_PASSWORD=password --build-arg LOG_LEVEL=ERROR -t flask-shop-api:latest .\n    $ eval $(minikube docker-env)\n    $ kubectl apply -f k8deploy.yaml\n    $ kubectl expose deployment flask-shop-api-deploy --type=NodePort --port=8000\n    $ minikube service flask-shop-api-deploy\n\nOptional forwarding port\n\n    $ kubectl port-forward service/flask-shop-api-deploy 5001:8000\n  \n**Running unittests**\n    \nFirst setup the .env for test environment then run the following command from project root:\n    \n    $ pytest\n\n**Other Commands on** \n\n    python manage.py --help\n\n_(Optional)Install Ipython to get interactive shell using Ipython for the app_\n\n\n**Demo URL**\n\n`https://flask-shop-api.vercel.app`\n\n###### Login Credentials\n\nusername: `demo@mail.com`\n\npassword: `demo_pass`\n\n\n###### Routes\n\n* /api/v1/auth/generate-jwt\n* /api/v1/users\n* /api/v1/categories\n* /api/v1/products\n* /api/v1/statuses\n* /api/v1/orders\n* /api/v1/reviews\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsartim%2Fflask_shop_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsartim%2Fflask_shop_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsartim%2Fflask_shop_api/lists"}