docs: move environment setup to monorepo root

This commit is contained in:
PalmDevs
2024-01-17 22:44:59 +07:00
parent 97c5bd5634
commit 526d514443
4 changed files with 36 additions and 12 deletions

View File

@@ -2,9 +2,6 @@
There are many methods to run the server. Choose one that suits best for the situation.
> [!IMPORTANT]
> Make sure you've followed the [**🏗️ Setting up the environment**](./0_development_environment.md) steps.
## 👷🏻 Development mode (recommended)
There will be no compilation step, and Bun will automatically watch changes and restart the server for you.
@@ -39,3 +36,10 @@ bun bundle
```
The files will be placed in the `dist` directory. **Configurations and `.env` files will NOT be copied automatically.**
You can run these files after using a runtime, eg. `bun run .` or `node .`.
## ⏭️ What's next
The next page will tell you about packets.
Continue: [📨 Packets](./3_packets.md)

View File

@@ -4,13 +4,13 @@ This documentation explains how the server works, how to start developing, and h
## 📖 Table of contents
0. [🏗️ Setting up the development environment](./0_development_environment.md)
0. [🏗️ Set up the development environment (if you haven't already)](../../../docs/0_development_environment.md)
1. [⚙️ Configuration](./1_configuration.md)
2. [🏃🏻‍♂️ Running the server](./2_running.md)
3. [📨 Packets](./3_packets.md)
## ⏭️ Start here
The next page will tell you how to set up the development environment.
The next page will tell you how to configure the server.
Continue: [🏗 Setting up the development environment](./0_development_environment.md)
Continue: [ Configuration](./1_configuration.md)

View File

@@ -24,16 +24,23 @@ To start developing, you'll need to set up the development environment first.
4. Build packages/libraries
```sh
bun build:libs
bun run build
```
5. Change your directory to this project's root
5. Change your directory to a project's root
```sh
# WebSocket API
cd apis/websocket
# Discord bot
cd bots/discord
# Programmatic API
cd packages/api
# Etc.
```
## ⏭️ What's next
The next page will tell you about server configurations.
Continue: [⚙️ Configuration](./1_configuration.md)
You'll need to go to the respective project's documentation to continue.

13
docs/README.md Normal file
View File

@@ -0,0 +1,13 @@
# 🚙 ReVanced Bot
This documentation are steps required to start developing ReVanced bots.
## 📖 Table of contents
0. [🏗️ Setting up the development environment](./0_development_environment.md)
## ⏭️ Start here
The next page will tell you how to set up the development environment.
Continue: [🏗️ Setting up the development environment](./0_development_environment.md)