A nimble Mastodon web client
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Vince Chu fbc779d174
chore: Add elk.mstdn.ca to README.md (#2154)
2 days ago
.github chore: publish docker images on forks (#2106) 3 weeks ago
.stackblitz chore: make Codeflow bot comment every issue (#984) 5 months ago
.vscode chore(i18n): `en` as source language (#1597) 4 months ago
components fix: handle hidden followers/following count (#2120) 1 week ago
composables fix: poll would sometimes remove last entry (#2117) 3 weeks ago
config chore: add generate pwa icons script (#2130) 2 weeks ago
constants fix: handle frozen page lifecycle state (#1658) 4 months ago
docs docs: typo in the sharp-ico repository link (#2142) 7 days ago
https-dev-config feat: added a profile settings and settings nav (#432) 6 months ago
images docs: fix images in readme 5 months ago
layouts feat: search back to the right (#2071) 1 month ago
locales fix(i18n): update eu-ES.json (#2129) 2 weeks ago
middleware refactor: move single instance config to runtime (#1664) 4 months ago
mocks perf: tree-shake dependencies from server (#1647) 4 months ago
modules fix(pwa): pwa icons in dev and build (#2137) 2 weeks ago
pages feat(pwa): add screenshots and orientation to webmanifest (#2109) 3 weeks ago
patches fix(deps): update dependencies (#1908) 3 months ago
plugins fix: respect zenMode preference default 1 month ago
public chore: add generate pwa icons script (#2130) 2 weeks ago
public-dev chore: add generate pwa icons script (#2130) 2 weeks ago
public-staging chore: add generate pwa icons script (#2130) 2 weeks ago
scripts chore: add generate pwa icons script (#2130) 2 weeks ago
server chore(deps): update lint (#2011) 1 month ago
service-worker feat(pwa): add screenshots and orientation to webmanifest (#2109) 3 weeks ago
styles fix: emoji sizing (#2007) 2 months ago
tests chore: upgrade deps 3 months ago
types feat: poll creation (#2111) 3 weeks ago
utils feat(i18n): `ca-valencia` language detection in Edge browser (#1828) 3 months ago
.dockerignore feat: add docker support (#1052) 5 months ago
.env.example refactor: move single instance config to runtime (#1664) 4 months ago
.env.mock fix: key current instance on user server, not user id (#466) 6 months ago
.eslintignore chore: add generate pwa icons script (#2130) 2 weeks ago
.eslintrc fix: replace a tag with NuxtLink (#906) 5 months ago
.gitignore feat: add translation status to language settings (#1717) 4 months ago
.npmrc chore: ignore pnpm `ignore-workspace-root-check` 5 months ago
.nvmrc chore: add .nvmrc to ensure node v18 (#1579) 4 months ago
.stackblitzrc feat: mock user in dev (#221) 6 months ago
CODE_OF_CONDUCT.md chore: add code of conduct (#1743) 4 months ago
CONTRIBUTING.md docs: update translation guide file to copy (#2017) 2 months ago
Dockerfile chore: copy across `.npmrc` to docker build (#2152) 2 days ago
LICENSE chore: add license 7 months ago
README.md chore: Add elk.mstdn.ca to README.md (#2154) 2 days ago
app.vue refactor: use head script instead of cookie 5 months ago
docker-compose.yaml fix: extended docker-compose.yml to addres Bug #1696 (#1701) 3 months ago
elk.svg refactor: compress svg files 5 months ago
emoji-mart-traslation.d.ts feat(i18n): Emojimart localization and `fetching` entry at `en` … (#1731) 4 months ago
error.vue chore(deps): update lint (#1928) 2 months ago
netlify.toml chore: move docs redirect into `_redirects` (#895) 5 months ago
nuxt.config.ts chore(deps): update lint (#2011) 1 month ago
package.json fix(deps): update dependency @vueuse/motion to v2.0.0 (#2131) 3 days ago
page-lifecycle.d.ts fix: handle frozen state (#1792) 3 months ago
pnpm-lock.yaml fix(deps): update dependency @vueuse/motion to v2.0.0 (#2131) 3 days ago
pnpm-workspace.yaml docs: add initial documentation (#842) 5 months ago
shims.d.ts refactor: inject pwa client plugin from module (#1758) 4 months ago
tsconfig.json refactor: switch nuxt module of vue macros (#27) 7 months ago
unocss.config.ts fix(default): update layout to use dynamic vh (#1817) 1 month ago
vitest.config.mjs chore: migrate to nuxt-vitest 4 months ago


Elk logo

Elk alpha

A nimble Mastodon web client

discord chat Start new PR in StackBlitz Codeflow Open board on Volta

Elk screenshots

⚠️ Elk is in Alpha

It is already quite usable, but it isn't ready for wide adoption yet. We recommend you use it if you would like to help us build it. We appreciate your feedback and contributions. Check out the Open Issues and jump in the action. Join the Elk discord server to chat with us and learn more about the project.


Official Deployment

The Elk team maintains a deployment at:

Self-Host Docker Deployment

In order to host Elk yourself you can use the provided Dockerfile to build a container with elk. Be aware, that Elk only loads properly if the connection is done via SSL/TLS. The Docker container itself does not provide any SSL/TLS handling. You'll have to add this bit yourself. One could put Elk behind popular reverse proxies with SSL Handling like Traefik, NGINX etc.

  1. checkout source git clone https://github.com/elk-zone/elk.git
  2. got into new source dir: cd elk
  3. build Docker image: docker build .
  4. create local storage directory for settings: mkdir elk-storage
  5. adjust permissions of storage dir: sudo chown 911:911 ./elk-storage
  6. start container: docker-compose up -d

Note: The provided Dockerfile creates a container which will eventually run Elk as non-root user and create a persistent named Docker volume upon first start (if that volume does not yet exist). This volume is always created with root permission. Failing to change the permissions of /elk/data inside this volume to UID:GID 911 (as specified for Elk in the Dockerfile) will prevent Elk from storing it's config for user accounts. You either have to fix the permission in the created named volume, or mount a directory with the correct permission to /elk/data into the container.


These are known deployments using Elk as an alternative Web client for Mastodon servers or as a base for other projects in the fediverse:

Note: Community deployments are NOT maintained by the Elk team. It may not be synced with Elk's source code. Please do your own research about the host servers before using them.

💖 Sponsors

We are grateful for the generous sponsorship and help of:



And all the companies and individuals sponsoring Elk Team and the members. If you're enjoying the app, consider sponsoring us:

Or you can sponsor our core team members individually:

We would also appreciate sponsoring other contributors to the Elk project. If someone helps you solve an issue or implement a feature you wanted, supporting them would help make this project and OS more sustainable.

📍 Roadmap

Open board on Volta

🧑‍💻 Contributing

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


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. Once the elk repo has been cloned in Codeflow, the dev server will start automatically and print the URL to open the App. You should receive a prompt in the bottom-right suggesting to open it in the Editor or in another Tab. To learn more, check out the Codeflow docs.

Open in Codeflow

Local Setup

Clone the repository and run on the root folder:

pnpm i
pnpm run dev

Warning: you will need corepack enabled, check out the Elk Contributing Guide for a detailed guide on how to set up the project locally.

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

nr dev


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

nr test


You can consult the PWA documentation to learn more about the PWA capabilities on Elk, how to install Elk PWA in your desktop or mobile device and some hints about PWA stuff on Elk.

🦄 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
  • vite-plugin-pwa - Prompt for update, Web Push Notifications and Web Share Target API

👨‍💻 Contributors

📄 License

MIT © 2022-PRESENT Elk contributors