{"id":20886169,"url":"https://github.com/shiyinq/quest-by-system","last_synced_at":"2026-05-18T00:09:52.678Z","repository":{"id":238284815,"uuid":"796249209","full_name":"Shiyinq/quest-by-system","owner":"Shiyinq","description":"📜 A quest will be assigned to you by LLM.","archived":false,"fork":false,"pushed_at":"2024-07-13T14:48:30.000Z","size":3339,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-21T05:42:14.645Z","etag":null,"topics":["bot","fastapi","generative-ai","llm","ollama-bot","sveltekit","telegrafjs"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Shiyinq.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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-05-05T11:51:13.000Z","updated_at":"2024-10-27T02:43:32.000Z","dependencies_parsed_at":"2025-07-21T05:38:04.270Z","dependency_job_id":null,"html_url":"https://github.com/Shiyinq/quest-by-system","commit_stats":null,"previous_names":["shiyinq/quest-by-system"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Shiyinq/quest-by-system","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shiyinq%2Fquest-by-system","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shiyinq%2Fquest-by-system/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shiyinq%2Fquest-by-system/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shiyinq%2Fquest-by-system/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Shiyinq","download_url":"https://codeload.github.com/Shiyinq/quest-by-system/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shiyinq%2Fquest-by-system/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33160170,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-17T22:39:12.733Z","status":"ssl_error","status_checked_at":"2026-05-17T22:39:10.741Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["bot","fastapi","generative-ai","llm","ollama-bot","sveltekit","telegrafjs"],"created_at":"2024-11-18T08:16:01.478Z","updated_at":"2026-05-18T00:09:47.671Z","avatar_url":"https://github.com/Shiyinq.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QUEBYS - QUEST BY SYSTEM\n[![GitHub top language](https://img.shields.io/github/languages/top/Shiyinq/quest-by-system)](https://github.com/Shiyinq/quest-by-system)\n![GitHub repo size](https://img.shields.io/github/repo-size/Shiyinq/quest-by-system)\n![GitHub last commit](https://img.shields.io/github/last-commit/Shiyinq/quest-by-system)\n![GitHub commit activity](https://img.shields.io/github/commit-activity/w/Shiyinq/quest-by-system)\n\n\n| ![Home](docs/images/web/home.png) | ![Quests](docs/images/web/quests.png) | ![Detail Quest](docs/images/web/detail.png) | ![Profile](docs/images/web/profile.png) |\n|:---:|:---:|:---:|:---:|\n\n| ![Home](docs/images/bot/menu.png) | ![Quests](docs/images/bot/generated.png) | ![Detail Quest](docs/images/bot/detail.png) | ![Profile](docs/images/bot/profile.png) |\n|:---:|:---:|:---:|:---:|\n\nSometimes we get confused about what to do today. For example, I'm a software engineer who often gets confused about how to fill my free time. As a result, my days are filled with sleeping or playing games. Therefore, this casual project was created. You will be given quests by an open-source LLM powered by Ollama, so you have references on what to do, for instance, as a software engineer. In short, just like in an MMORPG game, you will be given quests by the system.\n\n## Table of Contents\n- [QUEBYS - QUEST BY SYSTEM](#quebys---quest-by-system)\n  - [Table of Contents](#table-of-contents)\n  - [Requirements](#requirements)\n  - [Getting Started with Docker](#getting-started-with-docker)\n  - [Development](#development)\n    - [Run the backend](#run-the-backend)\n    - [Run the frontend and telegram bot](#run-the-frontend-and-telegram-bot)\n    - [Contributing](#contributing)\n\n\n## Requirements\n- Python v3.9.12 ~\n- MongoDB  v5.0\n- Ollama latest version\n- Docker latest version\n\n## Getting Started with Docker\n\nBefore you begin, ensure you have [Docker](https://docs.docker.com/engine/install/) installed.\n\n**1. Clone the repository**\n```bash\ngit clone https://github.com/Shiyinq/quest-by-system.git\ncd quest-by-system\n```\n\n**2. Create environment files**\n\nFor the backend:\n```bash\ncp .env.example .env\n```\n\nFor the frontend:\n```bash\ncd client/web\ncp .env.example .env\ncd ..\n```\n\nFort the bot:\n```bash\ncd client/telegram-bot\ncp .env.example .env\ncd ../../\n```\n\nOpen each `.env` file you have created and update the values as needed.\n\n**3. Build and run the Docker containers**\n```bash\ndocker compose up --build -d\n```\nWait a few minutes for the setup to complete. You can then access:\n- Frontend at http://localhost:5000\n- Backend at http://localhost:8000\n- Telegram Bot at http://localhost:5050\n\n## Development\n### Run the backend\nMake sure you have [Ollama](https://ollama.com/)  installed and at least one model downloaded from Ollama. For a better experience, use the model `llama3:instruct`.\n\nAfter that, you can follow this instructions.\n\n**1. Clone this repository**\n```bash\ngit clone https://github.com/Shiyinq/quest-by-system.git\n```\n**2. Navigate to the project directory**\n```bash\ncd quest-by-system\n```\n**3. Create python environment**\n\nYou can use any Python environment like conda or others, but I am using venv.\n\ncreate environment\n```bash\npython -m venv .venv\n```\nactivate environment\n```bash\nsource .venv/bin/activate\n```\n**4. Install requirements**\n\nInstall the required dependencies with the following command:\n\n```\npip install -r requirements/dev.txt\n```\n**5. Create .env file**\n```bash\ncp .env.example .env\n```\n**6. Make sure you have created a MongoDB database** \n\nThe default `DB_NAME` is `quest`, but you can change it in the `.env` file.\n\n**7. Running the project**\n```bash\nsh scripts/start-dev.sh  \n```\nOpen API Docs\n ```bash\n http://localhost:5000/docs\n ```\n\n### Run the frontend and telegram bot\nYou can use the [API](http://localhost:5000/docs) to create your own client, but we already have clients available for you to try: a Telegram Bot and a Web client.\n\nDocumentation for the Telegram Bot and Web client is provided.\n- [Web](./client/web/README.md)\n- [Telegram Bot](./client/telegram-bot/README.md)\n\n### Contributing\n- You can open [issues](https://github.com/Shiyinq/quest-by-system/issues) to report bugs or request features.\n- You can fix bugs and add features on your own.\n  1. Fork this repository\n  2. Create a feature branch `git checkout -b new-feature`\n  3. Commit your changes `git commit -m 'Add new feature'`\n  4. Push to the branch `git push origin new-feature`\n  5. Create a Pull Request\n   ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshiyinq%2Fquest-by-system","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshiyinq%2Fquest-by-system","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshiyinq%2Fquest-by-system/lists"}