🔀 Fork of Elk (https://github.com/elk-zone/elk) with minor adjustments for https://elk.zio.sh
 
 
 
 
 
Go to file
Daniel Roe ab4321ad33
refactor: simplify assignment
2022-12-20 14:44:40 +00: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: links to Mastodon and Discord in app 2022-12-20 12:08:03 +01:00
composables refactor: simplify assignment 2022-12-20 14:44:40 +00:00
config feat: switch theme color on theme toggling (#454) 2022-12-19 23:37:23 +01:00
constants feat: pwa with push notifications (#337) 2022-12-17 23:29:16 +00:00
https-dev-config feat: pwa with push notifications (#337) 2022-12-17 23:29:16 +00:00
layouts feat: account switcher sidebar (#460) 2022-12-19 16:44:14 +01:00
locales chore: update app info 2022-12-20 11:58:50 +01:00
middleware fix: handle permalinks with app shell (#468) 2022-12-20 09:20:40 +01:00
modules feat: pwa with push notifications (#337) 2022-12-17 23:29:16 +00:00
pages ui: update icons 2022-12-19 21:31:12 +01:00
plugins fix: handle permalinks with app shell (#468) 2022-12-20 09:20:40 +01:00
public chore: remove unused favicons (#467) 2022-12-20 00:29:41 +01:00
public-dev chore: remove unused favicons (#467) 2022-12-20 00:29:41 +01:00
scripts chore: switch to `shiki-es` 2022-11-30 13:45:42 +08:00
server chore: use `ofetch` (newer version of `ohymfetch`) 2022-12-18 23:13:01 +00:00
service-worker feat: pwa with push notifications (#337) 2022-12-17 23:29:16 +00:00
styles ui: color for code block 2022-12-13 20:25:03 +01:00
tests fix: don't decode HTML entities (`&foo;`) until rendering (#465) 2022-12-20 00:23:06 +00:00
types feat: pwa with push notifications (#337) 2022-12-17 23:29:16 +00:00
.env.example fix: move config into `nuxt.config` 2022-11-30 21:28:55 +00:00
.env.mock fix: key current instance on user server, not user id (#466) 2022-12-20 01:16:15 +01:00
.eslintignore feat: pwa with push notifications (#337) 2022-12-17 23:29:16 +00:00
.eslintrc ci: force sort locales 2022-12-02 16:43:01 +08:00
.gitignore feat: pwa with push notifications (#337) 2022-12-17 23:29:16 +00: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: early alpha warning 2022-12-19 09:36:58 +01:00
app.vue feat: pwa with push notifications (#337) 2022-12-17 23:29:16 +00:00
error.vue feat: pwa with push notifications (#337) 2022-12-17 23:29:16 +00:00
html.d.ts chore: init 2022-11-13 13:34:43 +08:00
netlify.toml feat: pwa with push notifications (#337) 2022-12-17 23:29:16 +00:00
nuxt.config.ts feat: switch theme color on theme toggling (#454) 2022-12-19 23:37:23 +01:00
package.json chore: update vueuse 2022-12-20 15:22:21 +01:00
pnpm-lock.yaml chore: update vueuse 2022-12-20 15:22:21 +01:00
shims.d.ts feat: pwa with push notifications (#337) 2022-12-17 23:29:16 +00: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

README.md

Elk

A nimble Mastodon web client

Vite logo


discord chat Start new PR in StackBlitz Codeflow


Elk is in early alpha ⚠️

It is already quite usable, but it isn't ready for wide adoption yet. We recommend you to use if if you would like to help us building 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.

The client is deployed to elk.zone, you can share screenshots on social media but we prefer you avoid sharing this URL directly until the app is more polished. Feel free to share the URL with your friedns and invite others you think could be interested in helping to improve Elk.

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.

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

License

MIT