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.
- Python v3.9.12 ~
- MongoDB v5.0
- Ollama latest version
Make sure you have Ollama installed and at least one model downloaded from Ollama. For a better experience, use the model llama3:instruct.
After that, you can follow the next steps.
Steps to install this project:
-
Clone this repository
git clone https://github.com/Shiyinq/quest-by-system.git
-
Navigate to the project directory:
cd quest-by-system -
Create python environment
You can use any Python environment like conda or others, but I am using venv. create environment
python -m venv .venv
activate environment
source .venv/bin/activate -
Install dependencies:
pip install -r requirements/base.txt
-
Create .env file
cp .env.example .env
-
Make sure you have created a MongoDB database. The default
DB_NAMEisquest, but you can change it in the.envfile.
Running the project
sh scripts/start-dev.sh Open API Docs
http://localhost:5000/docs- You can open issues to report bugs or request features.
- You can fix bugs and add features on your own.
- Fork this repository
- Create a feature branch
git checkout -b new-feature - Commit your changes
git commit -m 'Add new feature' - Push to the branch
git push origin new-feature - Create a Pull Request
You can use the API 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.