ReVanced/revanced-bots
1
0
Fork 0
mirror of https://github.com/ReVanced/revanced-bots.git synced 2026-01-11 05:46:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
revanced-bots/docs/0_development_environment.md
PalmDevs a21aa348d7 fix: update repo url
2025-03-04 02:35:19 +07:00

1.0 KiB
Raw Permalink Blame History

🏗️ Setting up the development environment

Important

This project uses Bun to run and bundle the code. Compatibility with other runtimes (Node.js, Deno, ...) are not guaranteed and most package scripts won't work.

To start developing, you'll need to set up the development environment first.

  1. Install Bun

  2. Clone the mono-repository

    git clone https://github.com/revanced/revanced-bots.git &&
cd revanced-bots

  3. Install dependencies

    bun install

  4. Install Git hooks for linting (optional, but recommended)

    bunx lefthook install

  5. Build packages/libraries

    bun run build:packages

  6. Change your directory to a project's root

    # WebSocket API
cd apis/websocket

# Discord bot
cd bots/discord

# Programmatic API
cd packages/api

# Etc.

⏭️ What's next

You'll need to go to the respective project's documentation to continue.