Elk

A nimble Mastodon web client made with 🧡

Elk is in early alpha, but it is already quite usable. We would love your feedback and contributions.

Check out the Open Issues and jump in the action. Join the Elk discord server to learn more and get involved!

The client is deployed to elk.zone, you can share screenshots on social media but avoid sharing this URL or the discord server until we open the repo.

Note

If you would like to contribute, until the repo is open, please create branches in the main repository and send a PR from there.

Contributing

Hi! We're really excited that you're interested in contributing to Elk! Before submitting your contribution, please read through the following guide.

Online

You can use StackBlitz CodeFlow to fix bugs or implement features. You'll also see a CodeFlow button on PRs to review them without a local setup.

Local Setup

Clone the repository and run on the root folder:

pnpm i
pnpm run dev

We recommend installing ni, that will use the right package manager in each of your projects. If ni is installed, you can instead run:

ni
nr dev

Testing

Elk uses Vitest. You can run the test suite with:

nr test

Stack

Vite - Next Generation Frontend Tooling
Nuxt - The Intuitive Web Framework
Vue - The Progressive JavaScript Framework
VueUse - Collection of Vue Composition Utilities
Pinia - The Vue Store that you will enjoy using
Vue Macros - More macros and syntax sugar for Vue
UnoCSS - The instant on-demand atomic CSS engine
Iconify - Iconify icon sets in JSON format
Masto.js - Mastodon API client in TypeScript
shiki - A beautiful Syntax Highlighter

License

MIT

2.8 KiB Raw Blame History

Elk