Skip to content

ReVanced/revanced-api

Repository files navigation

Image
Image     Image     Image     Image     Image     Image     Image

Continuing the legacy of Vanced

🚀 ReVanced API

GitHub Workflow Status (with event) AGPLv3 License

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
  • ℹ️ About: Get more information such as a description, ways to donate to, and links of the hoster of ReVanced API
  • 💊 Manager: Get the latest updates of ReVanced Manager and its downloaders
  • 🧩 Patches: Get the latest updates of ReVanced Patches, directly from ReVanced API
  • 👥 Contributors: List all contributors involved in the project

🚀 How to get started

ReVanced API is deployed as a Cloudflare Worker.

🧑‍💻 Local development

  1. Install dependencies with bun install
  2. Copy .env.example to .env and fill in the required environment variables
  3. Create a local D1 database and run migrations with bun run db:migration:apply
  4. Start the development server with bun run dev

🌐 Deployment

bun run db:migration:apply --remote # Configure the database_id in wrangler.toml after this command.
bun run deploy

📚 Everything else

📙 Contributing

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

📜 Licence

ReVanced API is licensed under the AGPLv3 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.

About

🚀 API server for ReVanced

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors