A nimble Mastodon web client
Find a file
2022-12-17 22:35:07 +01:00
.github ci: disable GitHub Actions 2022-12-14 11:06:39 +01:00
.vscode feat(editor): select language 2022-11-30 06:47:24 +08:00
components feat: search (#285) 2022-12-17 22:35:07 +01:00
composables feat: search (#285) 2022-12-17 22:35:07 +01:00
config feat: Czech locale (#439) 2022-12-14 22:19:38 +01:00
constants feat: more to explore (#360) 2022-12-11 11:52:36 +01:00
layouts feat: search (#285) 2022-12-17 22:35:07 +01:00
locales feat: search (#285) 2022-12-17 22:35:07 +01:00
middleware feat: render app shell with ssr to improve loading experience (#448) 2022-12-17 17:55:29 +01:00
modules refactor: move shared config into ~/config/ 2022-12-06 21:04:38 +00:00
pages feat: focus editor on reply click (#434) 2022-12-14 17:45:46 +01:00
plugins feat: render app shell with ssr to improve loading experience (#448) 2022-12-17 17:55:29 +01:00
public perf: serve fonts from app (#382) 2022-12-09 17:32:09 +01:00
public-dev fix: use nitro overlay to skip dev assets in production 2022-12-08 11:50:44 +01:00
scripts chore: switch to shiki-es 2022-11-30 13:45:42 +08:00
server feat: enhance login and error handling (#423) 2022-12-14 00:12:16 +01:00
styles ui: color for code block 2022-12-13 20:25:03 +01:00
tests fix: don't parse rich content in display name (#449) 2022-12-17 21:01:20 +00:00
types feat: render app shell with ssr to improve loading experience (#448) 2022-12-17 17:55:29 +01:00
.env.example fix: move config into nuxt.config 2022-11-30 21:28:55 +00:00
.env.mock chore: update mock acct 2022-12-12 11:03:39 +00:00
.eslintignore feat: render app shell with ssr to improve loading experience (#448) 2022-12-17 17:55:29 +01:00
.eslintrc ci: force sort locales 2022-12-02 16:43:01 +08:00
.gitignore chore: ignore vim temp files (#280) 2022-12-02 04:05:45 +08:00
.npmrc chore: enable shell emulator on windows and start preview with correct port 2022-11-26 18:13:47 +00:00
.stackblitzrc feat: mock user in dev (#221) 2022-11-29 10:43:01 +01:00
app.vue feat: render app shell with ssr to improve loading experience (#448) 2022-12-17 17:55:29 +01:00
error.vue fix: update more public and explore links 2022-12-04 20:05:11 +00:00
html.d.ts chore: init 2022-11-13 13:34:43 +08:00
LICENSE chore: add license 2022-11-24 11:53:23 +01:00
netlify.toml ci: disable GitHub Actions 2022-12-14 11:06:39 +01:00
nuxt.config.ts feat: render app shell with ssr to improve loading experience (#448) 2022-12-17 17:55:29 +01:00
package.json feat: render app shell with ssr to improve loading experience (#448) 2022-12-17 17:55:29 +01:00
pnpm-lock.yaml feat: render app shell with ssr to improve loading experience (#448) 2022-12-17 17:55:29 +01:00
README.md chore: remove orange heart from readme 2022-12-14 21:13:12 +01:00
shims.d.ts feat: support attachment uploading 2022-11-24 01:17:54 +08:00
tsconfig.json refactor: switch nuxt module of vue macros (#27) 2022-11-23 09:07:28 +01:00
unocss.config.ts feat: DM improvements 2022-12-13 00:10:04 +01:00
vitest.config.ts feat: render app shell with ssr to improve loading experience (#448) 2022-12-17 17:55:29 +01:00

Elk

A nimble Mastodon web client

Vite logo


discord chat Start new PR in StackBlitz Codeflow


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.

Open in Codeflow

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