yrming / elk-desktop

Elk + Tauri FTW

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Elk desktop logo

Elk Desktop


discord chat


Desktop version of Elk, a nimble Mastodon web client made with šŸ§”

Elk Desktop is even more early alpha than the web version, but we would love your feedback and contributions.

Screenshot of the app, showing the federated timeline home Screenshot of the app, showing the federated timeline home

Contributing

We're really excited that you're interested in contributing to Elk! Please read through the small guide below to get started:

Note:
This repo only holds the code necessary for the desktop app and just git-submodules the frontend from https://github.com/elk-zone/elk so please submit Issues and PRs concerning the frontend there!

Local Setup

First you will need to install Rust and other system dependencies required for developing a Tauri app, you can follow this guide.

First, clone the submodule in the elk folder.

git submodule update --init elk

Next install the frontend dependencies:

cd elk && pnpm i

Then you can run the app in development mode:

cargo tauri dev

To create a production build of the app:

cargo tauri build

Logging

This app uses a unified logging stream that encompasses both logs from the Rust Core as well as from the frontend. Log levels and filters can be set through the RUST_LOG environment variable (this also works in a release mode app).

For more information on how to specify log levels and filters see the env_logger docs.

About

Elk + Tauri FTW


Languages

Language:Rust 100.0%