Fuyu

🏂 A self-hostable rest api server for Tenka.

By using this project, you agree to the usage policy.

Installation

Pre-built binaries are released in dist-* branches. To use these, you need to have git installed.

Clone this repository

For Windows:

git clone https://github.com/yukino-org/fuyu.git -b dist-windows

For Linux:

git clone https://github.com/yukino-org/fuyu.git -b dist-linux

For MacOS:

git clone https://github.com/yukino-org/fuyu.git -b dist-macos

Usage

<path/to/executable> --host <ip> --port <port> --modules <module1>[,<module2>,...]

Example:

fuyu --host 127.0.0.1 --port 8080 --modules twist.moe,mangadex.org

The help command can be invoked by using the help command. Also the /docs route contains the api documentation.

Technology

• Dart (Language)
• Pub (Dependency Manager)
• Git (Version Manager)

Code structure

• ./cli - Contains the local command-line tool.
• ./src - Contains the source code of the server.
• ./test - Contains unit tests.

Contributing

Ways to contribute to this project:

• Submitting bugs and feature requests at issues.
• Opening pull requests containing bug fixes, new features, etc.

License