A nimble Mastodon web client
Go to file
Anthony Fu 3d25243166
feat(ui): new replying status design (#846)
2023-01-08 09:27:21 +01:00
.github ci: switch back to github actions 2023-01-04 23:37:19 +08:00
.vscode chore: configure volar completion 2023-01-05 21:43:34 +08:00
components feat(ui): new replying status design (#846) 2023-01-08 09:27:21 +01:00
composables chore: change top-level function style 2023-01-08 09:21:35 +01:00
config refactor: html parsing 2023-01-07 10:31:48 +01:00
constants feat: allow setting default server via env (#854) 2023-01-07 22:38:31 +01: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 feat(ui): new replying status design (#846) 2023-01-08 09:27:21 +01:00
middleware refactor: upgrade masto 5 (#867) 2023-01-08 14:21:09 +08:00
modules fix(pwa): add `background_color` to web manifest (#832) 2023-01-06 22:04:17 +01:00
pages feat(ui): new replying status design (#846) 2023-01-08 09:27:21 +01:00
plugins feat: allow setting default server via env (#854) 2023-01-07 22:38:31 +01:00
public perf: use team avatars from local (#793) 2023-01-05 10:03:32 +00:00
public-dev feat: update elk icons (#717) 2023-01-03 08:14:53 +08:00
scripts perf: use team avatars from local (#793) 2023-01-05 10:03:32 +00:00
server refactor: env config (#769) 2023-01-04 14:26:30 +01:00
service-worker refactor: upgrade masto 5 (#867) 2023-01-08 14:21:09 +08:00
styles fix: make composer line height closer to final post 2023-01-07 22:51:22 +01:00
tests refactor: upgrade masto 5 (#867) 2023-01-08 14:21:09 +08:00
types refactor: upgrade masto 5 (#867) 2023-01-08 14:21:09 +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 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 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: update contributing guide typo (#836) 2023-01-06 22:02:08 +01:00
LICENSE chore: add license 2022-11-24 11:53:23 +01:00
README.md feat: update elk icons (#717) 2023-01-03 08:14:53 +08:00
app.vue feat: update design of square avatar (#808) 2023-01-05 23:21:31 +01:00
elk.svg feat: update elk icons (#717) 2023-01-03 08:14:53 +08:00
error.vue fix: default to local timeline when logged out (#855) 2023-01-07 13:35:42 -08:00
netlify.toml ci: remove testing on netlify 2023-01-04 23:43:05 +08:00
nuxt.config.ts refactor: generic components (#868) 2023-01-08 15:49:32 +08:00
package.json refactor: generic components (#868) 2023-01-08 15:49:32 +08:00
pnpm-lock.yaml refactor: generic components (#868) 2023-01-08 15:49:32 +08:00
shims.d.ts refactor: env config (#769) 2023-01-04 14:26:30 +01:00
tsconfig.json refactor: switch nuxt module of vue macros (#27) 2022-11-23 09:07:28 +01:00
unocss.config.ts feat: style experiments 2023-01-05 00:17:30 +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

Elk 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