{"id":20063724,"url":"https://github.com/oldcorvus/chickomenu","last_synced_at":"2025-07-24T06:34:29.737Z","repository":{"id":170919380,"uuid":"641279787","full_name":"oldcorvus/ChickoMenu","owner":"oldcorvus","description":"Digital menu QR code generator app backend","archived":false,"fork":false,"pushed_at":"2023-07-16T08:58:29.000Z","size":207,"stargazers_count":20,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-05T17:33:13.009Z","etag":null,"topics":["celery","celery-tasks","digital-menu","django","django-redis","django-rest-framework","djoser","docker","docker-compose","drf-yasg","flower","kavenegar","postgresql","psycopg2","qrcode-generator","redis","redis-cache","redis-django","swagger","unit-testing"],"latest_commit_sha":null,"homepage":"","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/oldcorvus.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":"2023-05-16T06:37:30.000Z","updated_at":"2024-08-21T16:35:14.000Z","dependencies_parsed_at":"2024-11-13T13:44:30.695Z","dependency_job_id":"647fc6ed-ae14-4e02-8a45-510ef5e4fc04","html_url":"https://github.com/oldcorvus/ChickoMenu","commit_stats":null,"previous_names":["oldcorvus/chickomenu"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/oldcorvus/ChickoMenu","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oldcorvus%2FChickoMenu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oldcorvus%2FChickoMenu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oldcorvus%2FChickoMenu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oldcorvus%2FChickoMenu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oldcorvus","download_url":"https://codeload.github.com/oldcorvus/ChickoMenu/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oldcorvus%2FChickoMenu/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266802657,"owners_count":23986384,"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","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["celery","celery-tasks","digital-menu","django","django-redis","django-rest-framework","djoser","docker","docker-compose","drf-yasg","flower","kavenegar","postgresql","psycopg2","qrcode-generator","redis","redis-cache","redis-django","swagger","unit-testing"],"created_at":"2024-11-13T13:43:37.141Z","updated_at":"2025-07-24T06:34:29.701Z","avatar_url":"https://github.com/oldcorvus.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ChickoMenu Digital Menu Generator\n\n**Note: This project is not finished yet!**\n\nCheck out the [sample front-end](https://github.com/younes-nb/chicko-frontend).\n\n# Setup\n\n1. Clone the repository:\n\n```sh\n$ git clone https://github.com/oldcorvus/ChickoMenu.git\n```\n\n2.Create a virtual environment and activate it:\n\n```sh\n$ virtualenv env\n$ source env/bin/activate\n```\n\n3.Install the required dependencies:\n\n```sh\n(env)$ pip install -r requirements/development.txt\n```\n# Environment Variables\n\nAfter pip has finished downloading the dependencies, create the following two .env files in the root of the project:\n\n## sample .env file:\n\n```sh\n# Celery Settings\nCELERY_BROKER_URL=redis://redis:6379/0\nCELERY_RESULT_BACKEND=redis://redis:6379/0\n\n# Flower Settings\nFLOWER_PORT=5555\nFLOWER_BASIC_AUTH=username:password\n```\n\n## sample .env.db file:\n\n```sh\nPOSTGRES_USER = postgres\nPOSTGRES_PASSWORD = postgres\nPOSTGRES_DB = ChickoMenu\n\n```\n\nCreate another .env file in ChickoMenu/settings/ with the following environment variables:\n\n## Sample .env file:\n\n```sh\nDEBUG=yes\nSECRET_KEY=django-insecure-czqrclgp!r826lvv19$8vpp6rky9#whlcp(epqzv$q8q!ex@$i\nDATABASE_URL=psql://chickomenu:chikomenu@127.0.0.1:5430/chikomenu\nSTATIC_URL=/static/\nAPI_KEY=\nDB_HOST=db\nDB_NAME=app\nDB_USER=postgres\nDB_PASS=supersecretpassword\n\n```\nThese variables are needed for the project to run correctly, and should be customized for your specific environment.\n\n# Running the Development Server\n\nTo run the development server locally, use the following command:\n\n```sh\n(env)$ python manage.py runserver --settings=ChickoMenu.settings.development\n\n```\nThen, navigate to http://127.0.0.1:8000/ in your web browser to view the site.\n\n# Running Locally with Docker\nIf you prefer to run the application using Docker, follow these steps:\n\n\n1.Build the Docker image:\n\n```sh\n  $ docker-compose build .\n```\n2.Spin up the containers:\n\n```sh\n  $ docker-compose up\n```\nOnce the containers are running, you can view the site at http://localhost:8000/.\n\n# Important\n\nIt is important to change sensitive information such as secret keys and API keys before deploying your application to production. Leaving default or test values in production can make your application vulnerable to security risks such as data breaches and unauthorized access\n\nGenerate a new secret key for your Django application using a cryptographically secure random generator. You can do this by running\n```sh\n python -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())\n ```\n \nin your terminal and replacing the SECRET_KEY value in your settings file with the new key.\n\n# Running Tests\n\nTo run the tests locally, use the following command:\n\n```sh\n(env)$ python manage.py test --settings=ChickoMenu.settings.development\n```\n\nIf you are using Docker, use the following command instead:\n\n```sh\n(env)$ docker-compose run web python manage.py test  --settings=ChickoMenu.settings.development\n\n```\nThis will run the test suite and output the results in the console. Use this to ensure that code is functioning properly and to catch any errors before deploying to production.\n\n\n# API Documentation\n\nTo view the API documentation, navigate to:\n\nhttp://127.0.0.1:8000/swagger/\nhttp://127.0.0.1:8000/redoc/\n  \n# Features\n\nThe ChickoMenu digital menu generator includes the following features:\n\nUser plan\nCatch for menu views\nOTP authentication\nMulti language\nToken-based authentication\nCelery \n...\n\nThese features enhance the functionality and security of the application.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foldcorvus%2Fchickomenu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foldcorvus%2Fchickomenu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foldcorvus%2Fchickomenu/lists"}