Skip to main content

Development

If you want to contribute to the project feel free to checkout the code and try to fix a bug or implement a feature.

Build Info​

The AURCache project comprises two main components: a Flutter frontend and a Rust backend.

Frontend (Flutter)​

To build the Flutter frontend, ensure you have Flutter SDK installed. Then, execute the following commands:

cd frontend
flutter pub get
flutter build web

Backend (Rust)​

To build the Rust backend, make sure you have Rust installed. Then, navigate to the backend directory and run:

cd backend
cargo build --release

Api Docs​

You can access the API docs (scalar) http://localhost:8080/docs after starting the backend.

Or if you prefer Redoc http://localhost:8080/redoc.