mirror of
https://github.com/revanced/revanced-api.git
synced 2025-05-04 08:34:34 +02:00
45ef33741c
* feat: sanic framework settings * feat: initial implementation * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * refactor: backend changes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix: docstrings out of place * feat: more gh endpoints * ci: fix pre-commit issues * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * feat: app info * ci: merge CI and fix triggers * chore: bump deps * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix: typing issues * chore: deps * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * refactor: clean up returns * ci: spread jobs correctly * ci: move to quodana * ci: fix issues with python modules * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * chore: pycharm config * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * refactor: improve code quality * feat: better README * ci: add quodana baseline config * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * ci: fix quodana config * ci: more qodana stuff * ci: revert qodana changes * ci: python interpreter detection is broken * feat: tests * ci: testing * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * ci: fix workflow names * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * chore: add deps * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * test: more tests * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * feat: /tools compat * feat: donations endpoint * feat: teams endpoint * fix: lock pydantic version * chore: deps * ci: docker builds * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * ci: remove coverage action and others * ci: pre-commit fixes --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
# ReVanced Releases API
|
|
|
|
---
|
|
|
|
|
|
[](https://github.com/revanced/revanced-api/actions/workflows/quodana.yml)
|
|
[](https://github.com/revanced/revanced-api/actions/workflows/mypy.yml)
|
|
|
|
---
|
|
|
|
This is a simple API that proxies requests needed to feed the ReVanced Manager and website with data.
|
|
|
|
## Usage
|
|
|
|
To run this API, you need Python 3.11.x. You can install the dependencies with poetry:
|
|
|
|
```shell
|
|
poetry install
|
|
```
|
|
|
|
Create an environment variable called `GITHUB_TOKEN` with a valid GitHub token with read access to public repositories.
|
|
|
|
Then, you can run the API in development mode with:
|
|
|
|
```shell
|
|
poetry run sanic app:app --dev
|
|
```
|
|
|
|
or in production mode with:
|
|
|
|
```shell
|
|
poetry run sanic app:app --fast
|
|
```
|
|
|
|
## Contributing
|
|
|
|
If you want to contribute to this project, feel free to open a pull request or an issue. We don't do much here, so it's pretty easy to contribute.
|
|
|
|
## License
|
|
|
|
This project is licensed under the AGPLv3 License - see the [LICENSE](LICENSE) file for details.
|