Project AIRI logoProject AIRI
backdrop
Characters
Overview

Contributing

Hello! Thank you for your interest in contributing to this project. This guide will help you get started.

Prerequisites

Windows setup

  1. Download Visual Studio, and follow the instructions here: https://rust-lang.github.io/rustup/installation/windows-msvc.html#walkthrough-installing-visual-studio-2022

    Make sure to install Windows SDK and C++ build tools when installing Visual Studio.

  2. Open PowerShell

  3. Install scoop

    powershell
    Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression

  4. Install git, Node.js, rustup, msvc through scoop

    powershell
    scoop install git nodejs rustup

# For Rust dependencies
# Not required if you are not going to develop on either crates or apps/tamagotchi
scoop install main/rust-msvc
# Rust & Windows specific
rustup toolchain install stable-x86_64-pc-windows-msvc
rustup default stable-x86_64-pc-windows-msvc

  5. Install pnpm through corepack

    powershell
    corepack enable
corepack prepare pnpm@latest --activate
macOS setup

  1. Open Terminal, (or iTerm2, Ghostty, Kitty, etc.)

  2. Install git, node through brew

    shell
    brew install git node

  3. Install pnpm through corepack

    shell
    corepack enable
corepack prepare pnpm@latest --activate
Linux setup

  1. Open Terminal

  2. Follow nodesource/distributions: NodeSource Node.js Binary Distributions to install node

  3. Follow Git to install git

  4. Install pnpm through corepack

    shell
    corepack enable
corepack prepare pnpm@latest --activate

  5. If you would love to help to develop the desktop version, you will need those dependencies:

    sudo apt install \
   libssl-dev \
   libglib2.0-dev \
   libgtk-3-dev \
   libjavascriptcoregtk-4.1-dev \
   libwebkit2gtk-4.1-dev

If you have already contributed to this project before

WARNING

If you haven't clone this repository, skip this section.

Make sure your local repository is up to date with the upstream repository:

shell
git fetch -all
git checkout main
git pull upstream main --rebase

If you have a working branch, to make your branch up to date with the upstream repository:

shell
git checkout <your-branch-name>
git rebase main

Fork this project

Click on the Fork button on the top right corner of the moeru-ai/airi page.

Clone

shell
git clone https://github.com/<your-github-username>/airi.git
cd airi

Create your working branch

shell
git checkout -b <your-branch-name>

Install dependencies

shell
corepack enable
pnpm install

# For Rust dependencies
# Not required if you are not going to develop on either crates or apps/tamagotchi
cargo fetch

TIP

We would recommend to install @antfu/ni to make your script simpler.

shell
corepack enable
npm i -g @antfu/ni

Once installed, you can

  • use ni for pnpm install, npm install and yarn install.
  • use nr for pnpm run, npm run and yarn run.

You don't need to care about the package manager, ni will help you choose the right one.

Choose the application you want to develop on

Stage Tamagotchi (Desktop version)

shell
pnpm dev:tamagotchi

TIP

For @antfu/ni users, you can

shell
nr dev:tamagotchi

Stage Web (Browser version for airi.moeru.ai)

shell
pnpm dev

TIP

For @antfu/ni users, you can

shell
nr dev

Documentation site

shell
pnpm dev:docs

TIP

For @antfu/ni users, you can

shell
nr dev:docs

Telegram bot integration

A Postgres database is required.

shell
cd services/telegram-bot
docker compose up -d

Configure .env

shell
cp .env .env.local

Edit the credentials in .env.local.

Migrate the database

shell
pnpm -F @proj-airi/telegram-bot db:generate
pnpm -F @proj-airi/telegram-bot db:push

Run the bot

shell
pnpm -F @proj-airi/telegram-bot start

TIP

For @antfu/ni users, you can

shell
nr -F @proj-airi/telegram-bot dev

Discord bot integration

shell
cd services/discord-bot

Configure .env

shell
cp .env .env.local

Edit the credentials in .env.local.

Run the bot

shell
pnpm -F @proj-airi/discord-bot start

TIP

For @antfu/ni users, you can

shell
nr -F @proj-airi/discord-bot dev

Minecraft agent

shell
cd services/minecraft

Start a Minecraft client, export your world with desired port, and fill-in the port number in .env.local.

Configure .env

shell
cp .env .env.local

Edit the credentials in .env.local.

Run the bot

shell
pnpm -F @proj-airi/minecraft-bot start

TIP

For @antfu/ni users, you can

shell
nr -F @proj-airi/minecraft-bot dev

Commit

Before commit

WARNING

Please make sure lint (static checkers) and TypeScript compilers are satisfied:

shell
pnpm lint && pnpm typecheck

TIP

If you have @antfu/ni installed, you can use nr to run the commands:

shell
nr lint && nr typecheck

Commit

shell
git add .
git commit -m "<your-commit-message>"

Push to your fork repository

shell
git push origin <your-branch-name> -u

You should be able to browse the branch on your fork repository.

TIP

If this is your first time contributing with this project, you need to add the upstream repository too:

shell
git remote add upstream https://github.com/moeru-ai/airi.git

Creating Pull Request

Navigate to moeru-ai/airi page, click on the Pull requests tab, and click on the New pull request button, click on the Compare across forks link, and select your fork repository.

Review the changes, and click on the Create pull request button.

Whooo-ya! You made it!

Congratulations! You made your first contribution to this project. You can now wait for the maintainers to review your pull request.