🔀 Fork of Elk (https://github.com/elk-zone/elk) with minor adjustments for https://elk.zio.sh
 
 
 
 
 
Go to file
Darius Kazemi 75f1a6b16e
docs: add note about pnpm install (#705)
2023-01-02 20:06:13 +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 fix: remove line-clamp from signatures in notifications (#703) 2023-01-02 18:42:05 +01:00
composables feat(settings): metadata (#699) 2023-01-02 23:00:11 +08:00
config feat: replace emoji with SVGs (#129) (#584) 2023-01-02 05:53:53 +01:00
constants feat(settings): show default font size 2022-12-30 04:08:50 +08:00
https-dev-config feat: added a profile settings and settings nav (#432) 2022-12-26 09:50:11 +01:00
images docs: fix images in readme 2023-01-02 18:06:06 +01:00
layouts fix: omit value property of isHydrated in template (#681) 2023-01-01 21:43:09 +01:00
locales fix: settings typo (#704) 2023-01-02 19:16:50 +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(settings): metadata (#699) 2023-01-02 23:00:11 +08:00
plugins feat: replace emoji with SVGs (#129) (#584) 2023-01-02 05:53:53 +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 feat: replace emoji with SVGs (#129) (#584) 2023-01-02 05:53:53 +01:00
server feat: get origin from client (#679) 2023-01-01 20:30:39 +01:00
service-worker feat(pwa): allow access elk users from service worker (#662) 2023-01-01 20:38:05 +01:00
styles feat: replace emoji with SVGs (#129) (#584) 2023-01-02 05:53:53 +01:00
tests feat: replace emoji with SVGs (#129) (#584) 2023-01-02 05:53:53 +01:00
types fix: rework setup to improve SSR compatibility 2022-12-28 02:06:54 +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: replace emoji with SVGs (#129) (#584) 2023-01-02 05:53:53 +01: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
CONTRIBUTING.md docs: add note about pnpm install (#705) 2023-01-02 20:06:13 +01:00
LICENSE chore: add license 2022-11-24 11:53:23 +01:00
README.md docs: fix images in readme 2023-01-02 18:06:06 +01:00
app.vue refactor: setup 2022-12-28 04:50:29 +01:00
error.vue refactor: setup 2022-12-28 04:50:29 +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 refactor: move meta to nuxt config 2023-01-02 06:03:35 +08:00
package.json feat: replace emoji with SVGs (#129) (#584) 2023-01-02 05:53:53 +01:00
pnpm-lock.yaml feat: replace emoji with SVGs (#129) (#584) 2023-01-02 05:53:53 +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 fix: revert #660 + patch 2022-12-30 19:16:23 +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.

Sponsors

We want to thanks the generous sponsoring and help of:

NuxtLabs

StackBlitz

And all the companies and individuals sponsoring Elk Team members. If you're enjoying the app, consider sponsoring our team:

We would also appreciate sponsoring other contributors to the Elk project. If someone helps you solve an issue or implement a feature you wanted, supporting them would help make this project and OS more sustainable.

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. Once the elk repo has been cloned in CodeFlow, the dev server will start automatically and print the URL to open the App. You should receive a prompt in the bottom-right suggesting to open it in the Editor or in another Tab. To learn more, check out the CodeFlow docs.

Open in Codeflow

Local Setup

Clone the repository and run on the root folder:

pnpm i
pnpm run dev

Warning: you will need corepack enabled, check out the Elk Contributing Guide for a detailed guide on how to set up the project locally.

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 © 2022-PRESENT Elk contributors