ReVanced/revanced-api
1
0
Fork 0
mirror of https://github.com/revanced/revanced-api.git synced 2025-04-30 06:34:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add prerequisites

Browse Source
This commit is contained in:
oSumAtrIX 2024-06-06 03:59:29 +02:00
parent 5976dfd536
commit 6b3dbab90b
No known key found for this signature in database
GPG Key ID: A9B3094ACDB604B4
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -126,6 +126,8 @@ To deploy ReVanced API standalone, you can either use the pre-built executable o
### 📦 Pre-built executable ### 📦 Pre-built executable
A Java Runtime Environment (JRE) must be installed.
1. [Download](https://github.com/ReVanced/revanced-api/releases/latest) ReVanced API to a folder 1. [Download](https://github.com/ReVanced/revanced-api/releases/latest) ReVanced API to a folder
2. In the same folder, create an `.env` file using [.env.example](.env.example) as a template 2. In the same folder, create an `.env` file using [.env.example](.env.example) as a template
3. In the same folder, create a `configuration.toml` file 3. In the same folder, create a `configuration.toml` file
@ -134,6 +136,8 @@ using [configuration.example.toml](configuration.example.toml) as a template
### 🛠️ From source ### 🛠️ From source
A Java Development Kit (JDK) and Git must be installed.
1. Run `git clone git@github.com:ReVanced/revanced-api.git` to clone the repository 1. Run `git clone git@github.com:ReVanced/revanced-api.git` to clone the repository
2. Copy [.env.example](.env.example) to `.env` and fill in the required values 2. Copy [.env.example](.env.example) to `.env` and fill in the required values
3. Copy [configuration.example.toml](configuration.example.toml) to `configuration.toml` and fill in the required values 3. Copy [configuration.example.toml](configuration.example.toml) to `configuration.toml` and fill in the required values
@ -147,7 +151,7 @@ Thank you for considering contributing to ReVanced API. You can find the contrib
### 🛠️ Building ### 🛠️ Building
In order to build ReVanced API, Java Development Kit (JDK) and Git must be installed first. To build ReVanced API, a Java Development Kit (JDK) and Git must be installed.
Follow the steps below to build ReVanced API: Follow the steps below to build ReVanced API:
1. Run `git clone git@github.com:ReVanced/revanced-api.git` to clone the repository 1. Run `git clone git@github.com:ReVanced/revanced-api.git` to clone the repository