🔀 Fork of Elk (https://github.com/elk-zone/elk) with minor adjustments for https://elk.zio.sh
 
 
 
 
 
Go to file
Anthony Fu 98a647f8ca chore: avoid `useHead` naming conflicts 2022-11-30 06:49:25 +08:00
.github chore: format files 2022-11-29 04:22:06 +08:00
.vscode feat(editor): select language 2022-11-30 06:47:24 +08:00
components feat(editor): select language 2022-11-30 06:47:24 +08:00
composables chore: avoid `useHead` naming conflicts 2022-11-30 06:49:25 +08:00
constants feat: toggleable feature flags (#209) 2022-11-28 23:57:27 +01:00
layouts fix(a11y): add more aria labels 2022-11-29 21:24:26 +00:00
locales refactor: i18n 2022-11-30 05:50:13 +08:00
middleware feat: disable SSR 2022-11-23 07:08:36 +08:00
modules refactor: drop `Setup` suffix for setup components 2022-11-25 16:08:30 +00:00
pages chore: avoid `useHead` naming conflicts 2022-11-30 06:49:25 +08:00
plugins feat: scroll to top (#237) 2022-11-29 21:15:53 +01:00
public feat: use blue favicon for dev/preview mode 2022-11-27 23:09:18 +00:00
scripts feat: support codeblock 2022-11-24 11:42:03 +08:00
server feat: use different app name for dev 2022-11-30 06:45:07 +08:00
styles feat: prevent arbitrary zooming on mobile devices (#234) 2022-11-29 16:27:35 +00:00
tests feat: improve code block parsing 2022-11-27 14:16:02 +08:00
types feat: implement elk permalinks (#229) 2022-11-29 21:51:52 +01:00
.env.example chore: update env example 2022-11-28 15:25:20 +08:00
.env.mock feat: mock user in dev (#221) 2022-11-29 10:43:01 +01:00
.eslintrc feat: support paginator in local timeline 2022-11-26 12:08:17 +08:00
.gitignore chore: install inspect 2022-11-27 14:54:56 +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
LICENSE chore: add license 2022-11-24 11:53:23 +01:00
README.md docs: fix codeflow link to open a new pr 2022-11-29 04:36:54 +08:00
app.vue feat: custom error page (#178) 2022-11-28 09:01:14 +00:00
error.vue feat: custom error page (#178) 2022-11-28 09:01:14 +00:00
html.d.ts chore: init 2022-11-13 13:34:43 +08:00
netlify.toml chore: issue templates (#202) 2022-11-28 15:48:50 +01:00
nuxt.config.ts feat: prevent arbitrary zooming on mobile devices (#234) 2022-11-29 16:27:35 +00:00
package.json feat(editor): select language 2022-11-30 06:47:24 +08:00
pnpm-lock.yaml feat(editor): select language 2022-11-30 06:47:24 +08: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: improve follow buttons (#238) 2022-11-29 21:04:23 +01:00
vitest.config.ts test: add more test for rich content 2022-11-25 16:56:18 +08:00

README.md

Vite logo


discord chat Start new PR in StackBlitz Codeflow


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.

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 Vue 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