A nimble Mastodon web client
Go to file
Tamas 21376e013a
feat(i18n): hu-HU.json update (#2489)
2023-11-29 22:27:04 +00:00
.github chore(deps): update all non-major dependencies (#2389) 2023-11-29 17:55:12 +00:00
.stackblitz chore: make Codeflow bot comment every issue (#984) 2023-01-12 10:26:46 +01:00
.vscode chore(i18n): `en` as source language (#1597) 2023-02-18 12:21:09 +01:00
components fix: move the ALT text button for video attahcments to the top (#2479) 2023-11-24 08:19:53 +00:00
composables feat(settings): convert metadata to text (#2444) 2023-11-27 12:17:58 +00:00
config feat(i18n): Add Hungarian translation (hu-HU) (#2373) 2023-09-15 21:25:34 +00:00
constants feat: filter notifications by type (#2371) 2023-09-06 09:13:16 +00:00
docs chore(deps): update devdependencies (#2310) 2023-09-05 12:55:03 +00:00
https-dev-config feat: added a profile settings and settings nav (#432) 2022-12-26 09:50:11 +01:00
images docs: fix images in readme 2023-01-02 18:06:06 +01:00
layouts feat: search back to the right (#2071) 2023-05-06 17:49:15 +02:00
locales feat(i18n): hu-HU.json update (#2489) 2023-11-29 22:27:04 +00:00
middleware fix: installed pwa shortcuts (#2205) 2023-07-07 11:56:06 +01:00
mocks perf: tree-shake dependencies from server (#1647) 2023-02-06 10:34:50 +01:00
modules refactor: upgrade vue-macros 2023-08-08 02:32:35 +08:00
pages feat: unify the style of `under construction` page (#2483) 2023-11-28 10:54:22 +00:00
patches chore: fix pwa type 2023-07-04 13:32:22 +08:00
plugins fix: some keyboard shortcuts not working in non-english (#2324) 2023-10-13 07:13:37 +00:00
public chore: add generate pwa icons script (#2130) 2023-05-29 16:52:27 +02:00
public-dev chore: add generate pwa icons script (#2130) 2023-05-29 16:52:27 +02:00
public-staging chore: add generate pwa icons script (#2130) 2023-05-29 16:52:27 +02:00
scripts chore(deps): update lint (#2233) 2023-08-02 10:28:18 +00:00
server chore(deps): update devdependencies (#2163) 2023-07-03 01:11:13 +08:00
service-worker chore(deps): update lint (#2233) 2023-08-02 10:28:18 +00:00
styles fix: btn-solid text color for dark mode (#2471) 2023-11-13 17:30:36 +00:00
tests chore(deps): update dependency prettier to v3 (#2257) 2023-08-02 10:37:43 +00:00
types feat: poll creation (#2111) 2023-05-20 21:23:41 +02:00
utils feat(i18n): `ca-valencia` language detection in Edge browser (#1828) 2023-02-28 22:36:05 +01:00
.dockerignore feat: add docker support (#1052) 2023-01-17 18:37:07 +08:00
.env.example refactor: move single instance config to runtime (#1664) 2023-02-07 04:10:43 -08:00
.env.mock fix: key current instance on user server, not user id (#466) 2022-12-20 01:16:15 +01:00
.eslintignore chore: add generate pwa icons script (#2130) 2023-05-29 16:52:27 +02:00
.eslintrc chore(deps): update lint (#2233) 2023-08-02 10:28:18 +00:00
.gitignore feat: add translation status to language settings (#1717) 2023-02-11 21:42:55 +01:00
.npmrc chore: remove default npm option 2023-07-04 13:06:17 +08:00
.nvmrc chore(deps): update all non-major dependencies (#2234) 2023-07-31 19:48:59 +01:00
.stackblitzrc feat: mock user in dev (#221) 2022-11-29 10:43:01 +01:00
CODE_OF_CONDUCT.md chore: add code of conduct (#1743) 2023-02-13 02:11:06 -08:00
CONTRIBUTING.md docs: update translation guide file to copy (#2017) 2023-04-25 17:41:51 +02:00
Dockerfile chore: copy across `.npmrc` to docker build (#2152) 2023-06-08 10:53:33 +01:00
LICENSE chore: add license 2022-11-24 11:53:23 +01:00
README.md docs: fix a broken link in README (#2322) 2023-08-10 10:06:52 +00:00
app.vue refactor: use head script instead of cookie 2023-01-14 10:55:16 +01:00
docker-compose.yaml fix: extended docker-compose.yml to addres Bug #1696 (#1701) 2023-03-01 08:17:34 +01:00
elk.svg refactor: compress svg files 2023-01-09 17:25:48 +08:00
emoji-mart-traslation.d.ts feat(i18n): Emojimart localization and `fetching` entry at `en` … (#1731) 2023-02-15 20:15:11 +01:00
error.vue chore(deps): update lint (#1928) 2023-03-30 19:01:24 +00:00
netlify.toml chore: move docs redirect into `_redirects` (#895) 2023-01-08 23:04:55 +00:00
nuxt.config.ts feat: allow https as frame-src (#2468) 2023-11-12 06:42:02 +00:00
package.json chore: update nuxt to v3.8.2 (#2490) 2023-11-29 22:26:10 +00:00
page-lifecycle.d.ts fix: handle frozen state (#1792) 2023-02-25 12:09:24 +01:00
pnpm-lock.yaml chore: update nuxt to v3.8.2 (#2490) 2023-11-29 22:26:10 +00:00
pnpm-workspace.yaml docs: add initial documentation (#842) 2023-01-08 22:42:59 +01:00
shims.d.ts refactor: inject pwa client plugin from module (#1758) 2023-02-16 10:23:26 +01:00
tsconfig.json refactor: switch nuxt module of vue macros (#27) 2022-11-23 09:07:28 +01:00
unocss.config.ts fix: btn-solid text color for dark mode (#2471) 2023-11-13 17:30:36 +00:00
vitest.config.mjs chore: migrate to nuxt-vitest 2023-01-29 14:20:48 +01:00
vue-compiler-options.d.ts fix: augment vueCompilerOptions in `pkg-types` 2023-07-31 17:15:53 +01:00


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

πŸ“² PWA

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