🔀 Fork of Elk (https://github.com/elk-zone/elk) with minor adjustments for https://elk.zio.sh
 
 
 
 
 
Go to file
Anthony Fu 378ba25997 ui: fix double borders 2022-12-27 23:18:16 +01:00
.github ci: disable GitHub Actions 2022-12-14 11:06:39 +01:00
.vscode i18n: clean up unused keys 2022-12-27 19:00:42 +01:00
components ui: fix double borders 2022-12-27 23:18:16 +01:00
composables fix: insert space around custom emojis 2022-12-27 22:08:48 +01:00
config feat: cleanup locale conf and add some RTL stuff (#564) 2022-12-27 22:04:52 +01:00
constants feat: custom emojis, close #500 2022-12-23 23:56:21 +01:00
https-dev-config feat: added a profile settings and settings nav (#432) 2022-12-26 09:50:11 +01:00
layouts feat: rework user picker (#568) 2022-12-27 21:07:19 +01:00
locales feat: search on small screens (#585) 2022-12-27 22:41:44 +01:00
middleware fix: use lazy pagination (#563) 2022-12-26 09:34:30 +01:00
modules feat: display version 2022-12-26 20:33:19 +01:00
pages feat: search on small screens (#585) 2022-12-27 22:41:44 +01:00
plugins refactor: move post-login push logic to single place 2022-12-26 08:47:23 +01:00
public feat: emoji font 2022-12-27 19:37:22 +01:00
public-dev chore: remove unused favicons (#467) 2022-12-20 00:29:41 +01:00
scripts chore: script for release 2022-12-26 20:15:23 +01:00
server fix: normalize server name 2022-12-24 01:51:45 +01:00
service-worker fix: request push notifications on mobile (#553) 2022-12-26 10:13:59 +01:00
styles fix: insert space around custom emojis 2022-12-27 22:08:48 +01:00
tests fix: insert space around custom emojis 2022-12-27 22:08:48 +01:00
types feat: display version 2022-12-26 20:33:19 +01:00
.env.example feat: add invite link for easier onboarding (#481) 2022-12-20 22:39:04 +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: emoji font 2022-12-27 19:37:22 +01:00
error.vue ui: improve pwa prompt 2022-12-23 19:05:48 +01: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: display version 2022-12-26 20:33:19 +01:00
package.json chore: release v0.1.4 2022-12-27 21:57:17 +01:00
pnpm-lock.yaml fix: emoji replacement 2022-12-27 21:42:58 +01:00
shims.d.ts feat: display version 2022-12-26 20:33:19 +01:00
tsconfig.json refactor: switch nuxt module of vue macros (#27) 2022-11-23 09:07:28 +01:00
unocss.config.ts feat: added a profile settings and settings nav (#432) 2022-12-26 09:50:11 +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