Aller au contenu principal

Configurer l'environnement de développement

Clonage du dépôt​

Commencez par cloner le dépôt GitHub du projet OmniBot :

# Via HTTPS
git clone https://github.com/AsyncCommunityDiscord/OmniBot.git

# Via SSH
git clone git@github.com:AsyncCommunityDiscord/OmniBot.git

# Ensuite, accédez au répertoire du projet
cd OmniBot

Installation des outils nécessaires avec Mise​

Le projet OmniBot utilise TypeScript et Node.js. Afin de faciliter l'installation de l'environnement, le projet fournit un fichier de configuration mise.toml (mise-en-place).

Installation de Mise

Si vous n'avez pas encore installé Mise, vous pouvez le faire en suivant les instructions ci-dessous selon votre système d'exploitation. Pour plus d'informations, consultez le site officiel.

Pour installer Mise, vous pouvez utiliser la commande suivante dans PowerShell :

# Installation via Winget
winget install jdx.mise

# Installation via Scoop
scoop install mise

# Installation via Chocolatey
choco install mise

Après avoir installé Mise, vous pouvez installer tous les outils nécessaires (Node.js, pnpm, etc.) en lançant la commande suivante à la racine du projet :

mise install

Cela installera automatiquement toutes les versions requises définies dans le fichier mise.toml.

Installation des dépendances du projet​

Installez les dépendances Node.js avec pnpm :

pnpm install

Déploiement de la base de données PostgreSQL​

Le projet utilise Docker Compose pour déployer une base PostgreSQL. Assurez-vous d'avoir Docker installé, puis lancez :

docker compose up -d

Cela démarre le service PostgreSQL défini dans compose.yml.

Informations de connexion​

Voici les informations de connexion par défaut à la base de données PostgreSQL :

HostPortDatabaseUserPassword
localhost5432mydbuserpassword

Création des migrations Prisma​

Après avoir démarré la base de données, générez les migrations Prisma :

pnpm prisma:migrate

Cela va créer et appliquer les migrations sur la base PostgreSQL.

Ajout des variables d'environnement​

Ajoutez les variables d'environnement suivantes dans un fichier .env (que vous devez créer à la racine du projet), ou ajoutez les à votre environnement de développement :

VariableDescriptionExemple
DATABASE_URLURL de connexion à la base de donnéespostgresql://user:password@localhost:5432/mydb
DISCORD_TOKENToken de votre bot Discordyour-discord-bot-token

Avec ces étapes, votre environnement de développement pour OmniBot devrait être prêt ! Vous pouvez maintenant commencer à créer et tester vos modules personnalisés.