🔀 Fork of Elk (https://github.com/elk-zone/elk) with minor adjustments for https://elk.zio.sh
 
 
 
 
 
Go to file
三咲智子 Kevin Deng 523846e0ef
chore: release v0.4.0
2023-01-12 17:14:09 +08:00
.github docs: update sponsorship 2023-01-11 22:58:03 +01:00
.vscode chore: configure volar completion 2023-01-05 21:43:34 +08:00
components feat: add tooltip for user picker (#938) 2023-01-12 13:39:39 +08:00
composables refactor: output errors on devtools (#928) 2023-01-12 13:39:22 +08:00
config perf(pwa): exclude shiki from sw precache (#907) 2023-01-09 20:34:26 +01:00
constants feat: allow setting default server via env (#854) 2023-01-07 22:38:31 +01:00
docs fix(docs): correct twitter username 2023-01-11 16:32:23 +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: hydration problem on default layout (#831) 2023-01-07 03:38:40 +08:00
locales chore: prepare intro screen for opening up the repo 2023-01-12 01:39:53 +01:00
middleware refactor: output errors on devtools (#928) 2023-01-12 13:39:22 +08:00
modules chore: remove `/invite` route preparatory to launch 2023-01-11 22:50:52 +00:00
pages chore: point GitHub links to the elk repo 2023-01-12 01:41:25 +01:00
patches fix: nitro patch 2023-01-09 13:23:48 +01:00
plugins fix(pwa): handle sw registration error and status (#858) 2023-01-08 14:12:25 +00:00
public chore: add og image 2023-01-11 23:33:06 +01:00
public-dev refactor: compress svg files 2023-01-09 17:25:48 +08:00
public-staging refactor: compress svg files 2023-01-09 17:25:48 +08:00
scripts refactor: output errors on devtools (#928) 2023-01-12 13:39:22 +08:00
server chore: remove `/invite` route preparatory to launch 2023-01-11 22:50:52 +00:00
service-worker perf(pwa): exclude shiki from sw precache (#907) 2023-01-09 20:34:26 +01:00
styles feat: use square avatar when on own profile (#961) 2023-01-11 09:39:49 +01:00
tests fix: escape backticks within codeblocks 2023-01-11 23:54:45 +00:00
types fix: group follow notification 2023-01-09 20:23:15 +08:00
.env.example feat: allow setting default server via env (#854) 2023-01-07 22:38:31 +01:00
.env.mock fix: key current instance on user server, not user id (#466) 2022-12-20 01:16:15 +01:00
.eslintignore fix: patch `mlly` to solve bundle error 2023-01-08 11:15:21 +01:00
.eslintrc fix: replace a tag with NuxtLink (#906) 2023-01-09 14:22:19 +01:00
.gitignore chore: add cache for eslint 2023-01-07 02:48:55 +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
CONTRIBUTING.md chore: add info from README.md to contributing.md 2023-01-12 01:09:42 +01:00
LICENSE chore: add license 2022-11-24 11:53:23 +01:00
README.md chore: add info from README.md to contributing.md 2023-01-12 01:09:42 +01:00
app.vue chore: test open graph on edge 2023-01-11 22:51:23 +00:00
elk.svg refactor: compress svg files 2023-01-09 17:25:48 +08:00
error.vue refactor: output errors on devtools (#928) 2023-01-12 13:39:22 +08:00
netlify.toml chore: move docs redirect into `_redirects` (#895) 2023-01-08 23:04:55 +00:00
nuxt.config.ts feat: add large card support 2023-01-11 23:08:20 +00:00
package.json chore: release v0.4.0 2023-01-12 17:14:09 +08:00
pnpm-lock.yaml chore: check stale dep before running commands (#963) 2023-01-12 13:40:54 +08:00
pnpm-workspace.yaml docs: add initial documentation (#842) 2023-01-08 22:42:59 +01:00
shims.d.ts feat: different logos for staging and dev 2023-01-08 12:17:16 +01:00
tsconfig.json refactor: switch nuxt module of vue macros (#27) 2022-11-23 09:07:28 +01:00
unocss.config.ts feat: no borders in cards (#925) 2023-01-10 10:05:59 +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 logo

Elk alpha

A nimble Mastodon web client


discord chat Start new PR in StackBlitz Codeflow


Elk screenshots

⚠️ Elk is in Alpha

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

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 friends and invite others you think could be interested in helping to improve Elk.

💖 Sponsors

We are grateful for the generous sponsorship and help of:

NuxtLabs

StackBlitz

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

Or you can sponsor our core team members individually:

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.

📍 Roadmap

Open board on Volta

🧑‍💻 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