A nimble Mastodon web client
Find a file
Benben Weng 379f56795d
feat(i18n): add zh-TW translation (#1628)
Co-authored-by: Alex Liu <39984251+Mini-ghost@users.noreply.github.com>
2023-02-13 20:08:07 +01:00
.github chore: set github token permissions 2023-01-21 22:51:18 +00:00
.stackblitz chore: make Codeflow bot comment every issue (#984) 2023-01-12 10:26:46 +01:00
.vscode chore: configure volar completion 2023-01-05 21:43:34 +08:00
components feat(i18n): add missing Polish (and English) translation entries (#1669) 2023-02-12 17:59:07 +01:00
composables fix: revert #1699 (#1730) 2023-02-12 16:15:29 +01:00
config feat(docs): add translation status (#1689) 2023-02-11 17:15:08 +01:00
constants fix: handle frozen page lifecycle state (#1658) 2023-02-06 14:22:56 -08:00
docs chore: upgrade docs to nuxt 3.2.0 as well (#1728) 2023-02-12 04:09:55 -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: make nav title sticky + add more grabbale area for native (#1602) 2023-02-05 16:35:21 +01:00
locales feat(i18n): add zh-TW translation (#1628) 2023-02-13 20:08:07 +01:00
middleware refactor: move single instance config to runtime (#1664) 2023-02-07 04:10:43 -08:00
mocks perf: tree-shake dependencies from server (#1647) 2023-02-06 10:34:50 +01:00
modules fix: use nitro publicAssets to emit manifests 2023-02-12 15:49:20 +01:00
pages chore: upgrade to nuxt v3.2.0 (#1695) 2023-02-12 03:56:29 -08:00
patches fix: keep patches folder 2023-01-25 01:59:56 +08:00
plugins fix: close databases on page freeze event without pwa (#1662) 2023-02-06 15:01:30 -08:00
public fix(pwa): add maskable icon to web manifest (#1456) 2023-01-25 21:16:32 +01:00
public-dev fix(pwa): add maskable icon to web manifest (#1456) 2023-01-25 21:16:32 +01:00
public-staging fix(pwa): add maskable icon to web manifest (#1456) 2023-01-25 21:16:32 +01:00
scripts feat: add translation status to language settings (#1717) 2023-02-11 21:42:55 +01:00
server fix: use callback url with route param rather than query 2023-02-12 13:18:07 +01:00
service-worker fix: handle frozen page lifecycle state (#1658) 2023-02-06 14:22:56 -08:00
styles feat: add opt-in pinch to zoom setting (#1557) 2023-02-01 15:43:27 +01:00
tests fix: filter and cw logic (#1633) 2023-02-05 07:05:42 -08:00
types feat: add translation status to language settings (#1717) 2023-02-11 21:42:55 +01:00
utils fix: handle frozen page lifecycle state (#1658) 2023-02-06 14:22:56 -08:00
.dockerignore feat: add docker support (#1052) 2023-01-17 18:37:07 +08:00
.env.example refactor: move single instance config to runtime (#1664) 2023-02-07 04:10:43 -08:00
.env.mock fix: key current instance on user server, not user id (#466) 2022-12-20 01:16:15 +01:00
.eslintignore feat: add translation status to language settings (#1717) 2023-02-11 21:42:55 +01:00
.eslintrc fix: replace a tag with NuxtLink (#906) 2023-01-09 14:22:19 +01:00
.gitignore feat: add translation status to language settings (#1717) 2023-02-11 21:42:55 +01:00
.npmrc chore: ignore pnpm ignore-workspace-root-check 2023-01-12 10:45:11 +01:00
.nvmrc chore: add .nvmrc to ensure node v18 (#1579) 2023-02-08 10:23:07 +01:00
.stackblitzrc feat: mock user in dev (#221) 2022-11-29 10:43:01 +01:00
app.vue refactor: use head script instead of cookie 2023-01-14 10:55:16 +01:00
CODE_OF_CONDUCT.md chore: add code of conduct (#1743) 2023-02-13 02:11:06 -08:00
CONTRIBUTING.md chore: add .nvmrc to ensure node v18 (#1579) 2023-02-08 10:23:07 +01:00
docker-compose.yaml feat: add docker-compose support (#1257) 2023-01-17 21:04:53 +08:00
Dockerfile feat(docker): run as non root user (#1380) 2023-01-22 08:18:50 +01:00
elk.svg refactor: compress svg files 2023-01-09 17:25:48 +08:00
error.vue refactor: sync masto (#1121) 2023-01-15 16:38:02 +08:00
LICENSE chore: add license 2022-11-24 11:53:23 +01:00
netlify.toml chore: move docs redirect into _redirects (#895) 2023-01-08 23:04:55 +00:00
nuxt.config.ts chore: upgrade to nuxt v3.2.0 (#1695) 2023-02-12 03:56:29 -08:00
package.json chore: release v0.7.4 2023-02-12 20:27:57 +01:00
page-lifecycle.d.ts fix: handle frozen page lifecycle state (#1658) 2023-02-06 14:22:56 -08:00
pnpm-lock.yaml chore: upgrade docs to nuxt 3.2.0 as well (#1728) 2023-02-12 04:09:55 -08:00
pnpm-workspace.yaml docs: add initial documentation (#842) 2023-01-08 22:42:59 +01:00
README.md docs: add elk.aus.social to the ecosystem (#1555) 2023-02-01 04:36:15 -08:00
shims.d.ts test: add vitest-environment-nuxt (#1186) 2023-01-15 20:09:01 +01:00
tsconfig.json refactor: switch nuxt module of vue macros (#27) 2022-11-23 09:07:28 +01:00
unocss.config.ts fix: prevent videos from clipping when in fullscreen mode (#1397) 2023-02-07 06:32:37 -08:00
vitest.config.mjs chore: migrate to nuxt-vitest 2023-01-29 14:20:48 +01:00

Elk logo

Elk alpha

A nimble Mastodon web client


discord chat Start new PR in StackBlitz Codeflow Open board on Volta


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.

Deployment

Official Deployment

The Elk team maintains a deployment at:

Ecosystem

These are known deployments using Elk as an alternative Web client for Mastodon servers or as a base for other projects in the fediverse:

Note

: Community deployments are NOT maintained by the Elk team. It may not be synced with Elk's source code. Please do your own research about the host servers before using them.

💖 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

👨‍💻 Contributors

📄 License

MIT © 2022-PRESENT Elk contributors