Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shiyinq/quest-by-system
📜 A quest will be assigned to you by LLM.
https://github.com/shiyinq/quest-by-system
bot fastapi generative-ai llm ollama-client sveltekit telegrafjs
Last synced: about 12 hours ago
JSON representation
📜 A quest will be assigned to you by LLM.
- Host: GitHub
- URL: https://github.com/shiyinq/quest-by-system
- Owner: Shiyinq
- License: gpl-3.0
- Created: 2024-05-05T11:51:13.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-13T14:48:30.000Z (4 months ago)
- Last Synced: 2024-07-13T16:00:58.621Z (4 months ago)
- Topics: bot, fastapi, generative-ai, llm, ollama-client, sveltekit, telegrafjs
- Language: Python
- Homepage:
- Size: 3.18 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QUEBYS - QUEST BY SYSTEM
[](https://github.com/Shiyinq/quest-by-system)
|  |  |  |  |
|:---:|:---:|:---:|:---:|
|  |  |  |  |
|:---:|:---:|:---:|:---:|
Sometimes 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.
## Table of Contents
- [QUEBYS - QUEST BY SYSTEM](#quebys---quest-by-system)
- [Table of Contents](#table-of-contents)
- [Requirements](#requirements)
- [Getting Started with Docker](#getting-started-with-docker)
- [Development](#development)
- [Run the backend](#run-the-backend)
- [Run the frontend and telegram bot](#run-the-frontend-and-telegram-bot)
- [Contributing](#contributing)
## Requirements
- Python v3.9.12 ~
- MongoDB v5.0
- Ollama latest version
- Docker latest version
## Getting Started with Docker
Before you begin, ensure you have [Docker](https://docs.docker.com/engine/install/) installed.
**1. Clone the repository**
```bash
git clone https://github.com/Shiyinq/quest-by-system.git
cd quest-by-system
```
**2. Create environment files**
For the backend:
```bash
cp .env.example .env
```
For the frontend:
```bash
cd client/web
cp .env.example .env
cd ..
```
Fort the bot:
```bash
cd client/telegram-bot
cp .env.example .env
cd ../../
```
Open each `.env` file you have created and update the values as needed.
**3. Build and run the Docker containers**
```bash
docker compose up --build -d
```
Wait a few minutes for the setup to complete. You can then access:
- Frontend at http://localhost:5000
- Backend at http://localhost:8000
- Telegram Bot at http://localhost:5050
## Development
### Run the backend
Make 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`.
After that, you can follow this instructions.
**1. Clone this repository**
```bash
git clone https://github.com/Shiyinq/quest-by-system.git
```
**2. Navigate to the project directory**
```bash
cd quest-by-system
```
**3. Create python environment**
You can use any Python environment like conda or others, but I am using venv.
create environment
```bash
python -m venv .venv
```
activate environment
```bash
source .venv/bin/activate
```
**4. Install requirements**
Install the required dependencies with the following command:
```
pip install -r requirements/dev.txt
```
**5. Create .env file**
```bash
cp .env.example .env
```
**6. Make sure you have created a MongoDB database**
The default `DB_NAME` is `quest`, but you can change it in the `.env` file.
**7. Running the project**
```bash
sh scripts/start-dev.sh
```
Open API Docs
```bash
http://localhost:5000/docs
```
### Run the frontend and telegram bot
You 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.
Documentation for the Telegram Bot and Web client is provided.
- [Web](./client/web/README.md)
- [Telegram Bot](./client/telegram-bot/README.md)
### Contributing
- You can open [issues](https://github.com/Shiyinq/quest-by-system/issues) to report bugs or request features.
- You can fix bugs and add features on your own.
1. Fork this repository
2. Create a feature branch `git checkout -b new-feature`
3. Commit your changes `git commit -m 'Add new feature'`
4. Push to the branch `git push origin new-feature`
5. Create a Pull Request