A nimble Mastodon web client https://elk.zone
Find a file
2023-01-17 13:50:21 +01:00
.github chore: update pr template [skip ci] (#1160) 2023-01-15 16:15:48 +08:00
.stackblitz chore: make Codeflow bot comment every issue (#984) 2023-01-12 10:26:46 +01:00
.vscode chore: configure volar completion 2023-01-05 21:43:34 +08:00
components fix: show replying user in zen mode editor (#1250) 2023-01-17 13:50:21 +01:00
composables fix: use global regex to escape backticks (#1253) 2023-01-17 12:26:36 +01:00
config feat(i18n): sync and update zh-TW translation (#1255) 2023-01-17 19:46:50 +08:00
constants feat: theme colors (#1195) 2023-01-16 11:26:19 +01:00
docs refactor: remove unused DM Sans (#1192) 2023-01-15 20:13:07 +01: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 refactor: preferences settings (#1173) 2023-01-15 22:19:22 +08:00
locales feat(i18n): sync and update zh-TW translation (#1255) 2023-01-17 19:46:50 +08:00
middleware refactor: sync masto (#1121) 2023-01-15 16:38:02 +08:00
mocks perf: mock semver import (#1006) 2023-01-12 16:31:18 +00:00
modules feat: add support for the Web Share Target API (#1100) 2023-01-14 20:58:52 +00:00
pages feat: theme colors (#1195) 2023-01-16 11:26:19 +01:00
patches chore: upgrade mlly 2023-01-15 22:48:07 +08:00
plugins feat: theme colors (#1195) 2023-01-16 11:26:19 +01:00
public fix: disallow all indexing on canary site and indexing of auth-only pages in prod (#1175) 2023-01-15 14:34:23 +00:00
public-dev refactor: compress svg files 2023-01-09 17:25:48 +08:00
public-staging fix: disallow all indexing on canary site and indexing of auth-only pages in prod (#1175) 2023-01-15 14:34:23 +00:00
scripts feat: theme colors (#1195) 2023-01-16 11:26:19 +01:00
server perf: use server namespace to simplify kv querying (#1246) 2023-01-17 18:44:15 +08:00
service-worker perf: exclude pwa web manifests from sw precache (#1213) 2023-01-17 18:42:42 +08:00
styles fix(ui): translation button loading style issue in light theme (#1218) 2023-01-16 19:04:51 +01:00
tests fix: handle parsing pure plain text 2023-01-16 20:41:42 +00:00
types refactor: sync masto (#1121) 2023-01-15 16:38:02 +08:00
utils fix: default language (#1171) 2023-01-15 20:23:47 +08:00
.dockerignore feat: add docker support (#1052) 2023-01-17 18:37:07 +08:00
.env.example feat: add delete oauth app for admin 2023-01-15 17:34:17 +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: improve eslint ignore 2023-01-16 13:36:32 +01:00
.eslintrc fix: replace a tag with NuxtLink (#906) 2023-01-09 14:22:19 +01:00
.gitignore chore: add cache for eslint 2023-01-07 02:48:55 +08:00
.npmrc chore: ignore pnpm ignore-workspace-root-check 2023-01-12 10:45:11 +01:00
.stackblitzrc feat: mock user in dev (#221) 2022-11-29 10:43:01 +01:00
app.vue refactor: use head script instead of cookie 2023-01-14 10:55:16 +01:00
CONTRIBUTING.md chore(i18n): fix arabic on top to avoid changing contributing guide (#1088) 2023-01-14 11:45:12 +01:00
Dockerfile feat: add docker support (#1052) 2023-01-17 18:37:07 +08:00
elk.svg refactor: compress svg files 2023-01-09 17:25:48 +08:00
error.vue refactor: sync masto (#1121) 2023-01-15 16:38:02 +08:00
LICENSE chore: add license 2022-11-24 11:53:23 +01:00
netlify.toml chore: move docs redirect into _redirects (#895) 2023-01-08 23:04:55 +00:00
nuxt.config.ts fix: disable nuxt-security in dev 2023-01-17 11:51:32 +01:00
package.json fix(paginator): parse array in url query string correctly (#1242) 2023-01-17 05:48:26 +00:00
pnpm-lock.yaml fix(paginator): parse array in url query string correctly (#1242) 2023-01-17 05:48:26 +00:00
pnpm-workspace.yaml docs: add initial documentation (#842) 2023-01-08 22:42:59 +01:00
README.md docs: note about the risk for 3rd-party deployments (#1204) 2023-01-16 09:52:58 +01:00
shims.d.ts test: add vitest-environment-nuxt (#1186) 2023-01-15 20:09:01 +01:00
tsconfig.json refactor: switch nuxt module of vue macros (#27) 2022-11-23 09:07:28 +01:00
unocss.config.ts feat: theme colors (#1195) 2023-01-16 11:26:19 +01:00
vitest.config.mjs test: add vitest-environment-nuxt (#1186) 2023-01-15 20:09:01 +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.

Deployment

Official Deployment

The Elk team maintains a deployment at:

Ecosystem

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:

NuxtLabs

StackBlitz

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.

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. 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:

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
  • vite-plugin-pwa - Prompt for update and push notifications

👨‍💻 Contributors

📄 License

MIT © 2022-PRESENT Elk contributors