🔀 Fork of Elk (https://github.com/elk-zone/elk) with minor adjustments for https://elk.zio.sh
 
 
 
 
 
Go to file
Daniel Roe 08d629ea78
refactor: configure preview status with runtime config
2022-12-06 21:09:47 +00:00
.github ci: add lint 2022-12-05 13:04:18 +08:00
.vscode feat(editor): select language 2022-11-30 06:47:24 +08:00
components refactor: configure preview status with runtime config 2022-12-06 21:09:47 +00:00
composables refactor: configure preview status with runtime config 2022-12-06 21:09:47 +00:00
config refactor: move shared config into `~/config/` 2022-12-06 21:04:38 +00:00
constants fix: improve permalink handling somewhat 2022-12-01 22:59:08 +00:00
layouts feat(i18n): improve translations of command palette and others (#341) 2022-12-05 13:48:23 +08:00
locales fix: style overflow due to user content (#355) 2022-12-06 17:37:58 +01:00
middleware fix: update more public and explore links 2022-12-04 20:05:11 +00:00
modules refactor: move shared config into `~/config/` 2022-12-06 21:04:38 +00:00
pages feat: display status meta over card (#325) 2022-12-06 11:07:17 +00:00
plugins fix: scrollToTop does not work as expected (#271) 2022-12-01 20:33:07 +08:00
public feat: use blue favicon for dev/preview mode 2022-11-27 23:09:18 +00:00
scripts chore: switch to `shiki-es` 2022-11-30 13:45:42 +08:00
server refactor: configure preview status with runtime config 2022-12-06 21:09:47 +00:00
styles fix: style overflow due to user content (#355) 2022-12-06 17:37:58 +01:00
tests fix: setup jsdom environment 2022-12-05 12:59:04 +08:00
types feat: improve editor 2022-11-30 12:50:29 +08:00
.env.example fix: move config into `nuxt.config` 2022-11-30 21:28:55 +00:00
.env.mock feat: mock user in dev (#221) 2022-11-29 10:43:01 +01:00
.eslintignore i18n: improve translations 2022-11-30 07:26:07 +08: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
LICENSE chore: add license 2022-11-24 11:53:23 +01:00
README.md chore: update readme 2022-12-01 20:59:57 +01:00
app.vue chore: fix lint 2022-12-01 23:42:03 +08: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
netlify.toml chore: issue templates (#202) 2022-11-28 15:48:50 +01:00
nuxt.config.ts refactor: configure preview status with runtime config 2022-12-06 21:09:47 +00:00
package.json feat: display status meta over card (#325) 2022-12-06 11:07:17 +00:00
pnpm-lock.yaml feat: display status meta over card (#325) 2022-12-06 11:07:17 +00: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 fix: style overflow due to user content (#355) 2022-12-06 17:37:58 +01:00
vitest.config.ts test: add more test for rich content 2022-11-25 16:56:18 +08:00

README.md

Elk

Vite logo


discord chat Start new PR in StackBlitz Codeflow


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