Tuna 🍣

Tuna is an open-source music API built with Rust, Rocket, and SQLite.

It's designed to allow client-side automation and contributions, providing a simple, fast, and reliable way to maintain your music libraries.

Work in Progress 🚧

Tuna is currently under active development. All features and documentation are subject to change.

Features 📦

• User Management: Tuna offers a comprehensive API for managing other users, invites, and permissions. So you can safely share your music library with friends and family (or your army of bots).

• Music Management: Tuna allows you to easily manage your music library, including adding, removing, and updating songs, albums, and artists.

Quick Start 🚀

To get started, you'll need to have Rust installed on your system.

Then follow these steps to run Tuna on your local machine:

# Clone the repository
git clone https://github.com/5-pebbles/tuna.git tuna
# Change into the project directory
cd tuna
# Launch the server
cargo run
# And you're ready to go!

Documentation 📚

For detailed API documentation, including endpoints, parameters, and responses, please refer to the OpenAPI documentation:

• JSON
• YAML

These are generated with the help of Utoipa; the source code is located above each endpoints definition.

Testing 🧪

To run tests, you'll need to have hurl installed. Then simply run cargo test in your terminal.

Contact 📫

For any questions, feedback, or support, please open an issue on GitHub or contact me at 5-pebble@protonmail.com