Setup

Local Setup

1. Fork and clone the repo

   git clone https://github.com/[username]/Aimiko.git && cd Aimiko
   

   Or if you have the gh cli tool installed:

   gh repo clone [username]/Aimiko
   

2. Install all of the dependencies (including dev dependencies)

   poetry install --with=dev,tests,docs
   

3. Copy the ENV files into the correct places

   cp Envs/dev.env Bot/.env \
   cp Envs/docker.env .env
   

4. Edit the .env file placed in the root of the repo and in the Bot folder to include any credentials needed for the bot to run

   # THIS IS ONLY AN EXAMPLE
   POSTGRES_PASSWORD=...
   POSTGRES_USER=...
   POSTGRES_URI=postgres://user:somepass@localhost:5432/somedb
   

5. Start the Docker Compose stack

   sudo docker compose -f docker-compose-dev.yml up -d
   

6. Enable the PostgreSQL extension pg_trgm

   CREATE EXTENSION IF NOT EXISTS pg_trgm;
   

7. Run the database migrations

   python migrations-runner.py
   

Dev Mode

Aimiko v0.7+ includes an development mode feature, which will set up jishaku and a custom cog reloader, known as the FS watcher. The FS (File System) watcher is just like HMR (Hot Module Replacements). Once you press Ctrl+s in your cog, it will automatically reload it so the code executed is changed. Later on, there may be more development features that will be included. Make sure you first install the dev dependencies first! And in order to enable it, set an environment variable called DEV_MODE to True.