🚀 ReVanced API

API server for ReVanced.

❓ About

ReVanced API is a server that is used as the backend for ReVanced. ReVanced API acts as the data source for ReVanced Website and powers ReVanced Manager with updates and ReVanced Patches.

💪 Features

Some of the features ReVanced API include:

📢 Announcements: Post and get announcements grouped by channels
ℹ️ About: Get more information such as a description, ways to donate to, and links of the hoster of ReVanced API
🧩 Patches: Get the latest updates of ReVanced Patches, directly from ReVanced API
👥 Contributors: List all contributors involved in the project
🔄 Proxy: A proxy to an old API for migration purposes and backwards compatibility

🚀 How to get started

Clone the repository
Set up the environment variables in a .env file using the .env.example file as a template
Configure the configuration.toml file using the configuration.toml.example file as a template
Run the server using gradlew run --args=start

📚 Everything else

📙 Contributing

Thank you for considering contributing to ReVanced API. You can find the contribution guidelines here.

🛠️ Building

In order to build ReVanced API, follow these steps:

Clone the repository
Run gradlew build to build the project

📜 Licence

ReVanced API is licensed under the GPLv3 licence. Please see the licence file for more information. tl;dr you may copy, distribute and modify ReVanced API as long as you track changes/dates in source files. Any modifications to ReVanced API must also be made available under the GPL along with build & install instructions.

5.1 KiB Raw Blame History Unescape Escape