{"id":26697438,"url":"https://github.com/abduazizziyodov/ramazon-api","last_synced_at":"2025-04-13T04:26:17.470Z","repository":{"id":38461125,"uuid":"354529423","full_name":"AbduazizZiyodov/ramazon-api","owner":"AbduazizZiyodov","description":"🕌 API for Ramadan! Written in FastAPI","archived":false,"fork":false,"pushed_at":"2024-03-08T21:38:08.000Z","size":1564,"stargazers_count":22,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T21:19:22.952Z","etag":null,"topics":["backend","fastapi","python","ramadan","rest-api","swagger"],"latest_commit_sha":null,"homepage":"","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/AbduazizZiyodov.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,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-04-04T11:45:37.000Z","updated_at":"2025-03-05T01:41:16.000Z","dependencies_parsed_at":"2024-03-08T22:24:50.925Z","dependency_job_id":null,"html_url":"https://github.com/AbduazizZiyodov/ramazon-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/AbduazizZiyodov%2Framazon-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbduazizZiyodov%2Framazon-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbduazizZiyodov%2Framazon-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbduazizZiyodov%2Framazon-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AbduazizZiyodov","download_url":"https://codeload.github.com/AbduazizZiyodov/ramazon-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248662647,"owners_count":21141610,"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":["backend","fastapi","python","ramadan","rest-api","swagger"],"created_at":"2025-03-26T21:19:26.304Z","updated_at":"2025-04-13T04:26:17.451Z","avatar_url":"https://github.com/AbduazizZiyodov.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# **🕌 Ramazon-API**\n\n![FASTAPI_LOGO](/screenshots/fastapi.png)\n\n\u003cp align=\"center\"\u003e \n  Assalamu alaikum 👋 \u003cbr\u003e\n  Ramadan Mubarak. Wishing you a blessed and Happy Ramadan 😀\n\u003c/p\u003e\n\n## **🧰 Setup**\n\n\u003e **Required:** python +3.6\n\nClone this repository:\n\n```bash\n# git\n$ git clone https://github.com/AbduazizZiyodov/ramazon-api.git\n```\n\n```bash\n# github-cli:\n$ gh repo clone AbduazizZiyodov/ramazon-api\n```\n\nGo to the project directory. Create virtual enviroment and activate it:\n\n```bash\n$ cd ramazon-api/\n$ python -m venv env \u0026\u0026 source env/bin/activate\n\n# env/Scripts/activate - windows\n```\n\nInstall all required packages using `pip` from `requirements.txt` file.\n\n```bash\n$ pip install -r requirements.txt\n```\n\n\u003e Or, you can use `poetry` (if you have).\n\n```\n$ poetry install\n```\n\n# **🚀Running Server**\n\nTo run fastapi application you will have to use `uvicorn` or `gunicorn`.\n\n### **Uvicorn** 🦄\n\n\u003e `--reload` - reloading for development server.\n\n```bash\n$ uvicorn main:api --reload\n```\n\n### **Gunicorn** (🟢)🦄\n\n```bash\n$ gunicorn main:api --worker-class uvicorn.workers.UvicornWorker --reload\n```\n\n![SWAGGER_UI](/screenshots/swagger-ui.PNG)\n\n- `http://{{ host }}/swagger` - _Swagger UI_\n\n\u003chr\u003e\u003cbr\u003e\n\n## **✨Mocking Database**\n\nAfter running server, you should send `GET` request to `/simulate` endpoint from anywhere(swagger UI, curl, postman ...). The results of mocking will be logged on your terminal.\n\n![MOCK_RESULT](/screenshots/mock-result.PNG)\n\n## **🧪 Running Tests**\n\nRunning with `poetry`:\n\n```bash\n$ poetry run pytest\n```\n\nor\n\n```bash\n$ pytest\n```\n\n![TEST](/screenshots/test-result.PNG)\n\n\u003cp align=\"center\"\u003e \n  🐍 Abduaziz Ziyodov \n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabduazizziyodov%2Framazon-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabduazizziyodov%2Framazon-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabduazizziyodov%2Framazon-api/lists"}