Continuing the legacy of Vanced

🚀 ReVanced API

API server for ReVanced.

❓ About

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

💪 Features

Some of the features of ReVanced API include:

• 📢 Announcements: Push announcements grouped by channels
• ℹ️ About: Get more information such as a description, ways to donate and links about 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

🚀 How to get started

1. Clone the repository
2. Set up the environment variables in a .env file using the .env.example file as a template
3. Configure the configuration.toml file using the configuration.toml.example file as a template
4. 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:

1. Clone the repository
2. 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.