api.zlendy.com

This is the Rust codebase that powers api.zlendy.com. This project is meant to be used inside zlendy.com.

Getting started

Copy .env.example to .env and modify some values.

• RUST_LOG: Enables logging to stdout.
• UMAMI_URL (MODIFY ME): URL of self-hosted Umami Analytics instance (does not work with Umami Analytics Cloud).
• UMAMI_USERNAME (MODIFY ME): Username used to access Umami Analytics API (please use a view-only user)
• UMAMI_PASSWORD (MODIFY ME): Password of aforementioned user.
• UMAMI_WEBSITE_ID (MODIFY ME): Can be found in "Settings > Websites > Website ID".
• FEDIVERSE_URL: URL of Sharkey instance. May work with Misskey or its forks (untested)
• FEDIVERSE_USER_ID: Enable developer mode in "Settings > Other Settings > Other > Developer". Then go to the user profile and click on "... > Copy user ID".
• ZLENDY_URL: zlendy.com instance. May be modified when testing new features in localhost:5173.

Developing

(Optional) Install cargo-watch to recompile the project on save.

# choose one
cargo run
cargo watch -x run

Building

To create a production version of the project:

cargo build --release

Deploying

This project is meant to be deployed using Docker.

docker compose up --build