A nimble Mastodon web client
 
 
 
 
Go to file
Francesco 6dc5a68c80
feat(i18n): Update it-IT locale (#2630)
2024-02-26 13:22:51 +00:00
.github chore(deps): update docker/setup-qemu-action action to v3 (#2558) 2024-01-15 08:35:52 +00:00
.stackblitz chore: make Codeflow bot comment every issue (#984) 2023-01-12 10:26:46 +01:00
.vscode chore(i18n): `en` as source language (#1597) 2023-02-18 12:21:09 +01:00
components fix: allow to edit alt description of attached image again (#2631) 2024-02-26 13:11:21 +00:00
composables fix(cache): return cached account as promise (#2623) 2024-02-25 19:43:34 +00:00
config chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00:00
constants feat: filter notifications by type (#2371) 2023-09-06 09:13:16 +00:00
docs chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00: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 feat: search back to the right (#2071) 2023-05-06 17:49:15 +02:00
locales feat(i18n): Update it-IT locale (#2630) 2024-02-26 13:22:51 +00:00
middleware chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00:00
mocks refactor: migrate from shiki to shikiji (#2520) 2023-12-20 18:54:40 +00:00
modules chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00:00
pages chore: cleanup isHydrated (#2614) 2024-02-24 18:24:19 +00:00
patches chore: fix pwa type 2023-07-04 13:32:22 +08:00
plugins feat: add several new shortcut keys for navigation (#2618) 2024-02-24 19:28:56 +00:00
public chore: add generate pwa icons script (#2130) 2023-05-29 16:52:27 +02:00
public-dev chore: add generate pwa icons script (#2130) 2023-05-29 16:52:27 +02:00
public-staging chore: add generate pwa icons script (#2130) 2023-05-29 16:52:27 +02:00
scripts chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00:00
server feat: add Vercel KV (#2533) 2024-01-02 10:58:37 +00:00
service-worker chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00:00
styles fix: btn-solid text color for dark mode (#2471) 2023-11-13 17:30:36 +00:00
tests chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00:00
types feat: bump to latest vue 3.4.19 (#2607) 2024-02-24 12:24:21 +00:00
utils feat: bump to latest vue 3.4.19 (#2607) 2024-02-24 12:24:21 +00:00
.dockerignore refactor: migrate from shiki to shikiji (#2520) 2023-12-20 18:54:40 +00:00
.env.example feat: add Vercel KV (#2533) 2024-01-02 10:58:37 +00:00
.env.mock fix: key current instance on user server, not user id (#466) 2022-12-20 01:16:15 +01:00
.eslintignore chore: add generate pwa icons script (#2130) 2023-05-29 16:52:27 +02:00
.eslintrc chore(deps): update lint (#2233) 2023-08-02 10:28:18 +00:00
.gitattributes chore: include `.gitattributes` for eol (#2606) 2024-02-23 13:32:51 +00:00
.gitignore feat: show emoji tooltip (#2485) 2023-12-22 12:16:46 +00:00
.npmrc chore: remove default npm option 2023-07-04 13:06:17 +08:00
.nvmrc chore(deps): update dependency node to v20 (#2501) 2023-12-05 10:18:22 +00:00
.stackblitzrc feat: mock user in dev (#221) 2022-11-29 10:43:01 +01:00
CODE_OF_CONDUCT.md chore: add code of conduct (#1743) 2023-02-13 02:11:06 -08:00
CONTRIBUTING.md docs: update translation guide file to copy (#2017) 2023-04-25 17:41:51 +02:00
Dockerfile chore: copy across `.npmrc` to docker build (#2152) 2023-06-08 10:53:33 +01:00
LICENSE chore: add license 2022-11-24 11:53:23 +01:00
README.md refactor: migrate from shikiji to shiki v1 (#2591) 2024-02-15 07:43:09 +00:00
app.vue chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00:00
docker-compose.yaml fix: extended docker-compose.yml to addres Bug #1696 (#1701) 2023-03-01 08:17:34 +01:00
elk.svg refactor: compress svg files 2023-01-09 17:25:48 +08:00
emoji-mart-traslation.d.ts chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00:00
error.vue chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00:00
netlify.toml chore: move docs redirect into `_redirects` (#895) 2023-01-08 23:04:55 +00:00
nuxt.config.ts chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00:00
package.json fix(deps): update tiptap to v2.2.4 (#2398) 2024-02-24 19:26:14 +00:00
page-lifecycle.d.ts chore: update nuxt to 3.10.3 (#2610) 2024-02-24 16:46:14 +00:00
pnpm-lock.yaml fix(deps): update tiptap to v2.2.4 (#2398) 2024-02-24 19:26:14 +00:00
pnpm-workspace.yaml docs: add initial documentation (#842) 2023-01-08 22:42:59 +01:00
shims.d.ts refactor: inject pwa client plugin from module (#1758) 2023-02-16 10:23:26 +01:00
tsconfig.json refactor: switch nuxt module of vue macros (#27) 2022-11-23 09:07:28 +01:00
unocss.config.ts fix: btn-solid text color for dark mode (#2471) 2023-11-13 17:30:36 +00:00
vitest.config.ts chore(test): add `hanging-process` reporter on CI (#2622) 2024-02-25 14:13:27 +00:00
vue-compiler-options.d.ts fix: augment vueCompilerOptions in `pkg-types` 2023-07-31 17:15:53 +01:00

README.md

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:

Self-Host Docker Deployment

In order to host Elk yourself you can use the provided Dockerfile to build a container with elk. Be aware, that Elk only loads properly if the connection is done via SSL/TLS. The Docker container itself does not provide any SSL/TLS handling. You'll have to add this bit yourself. One could put Elk behind popular reverse proxies with SSL Handling like Traefik, NGINX etc.

  1. checkout source git clone https://github.com/elk-zone/elk.git
  2. got into new source dir: cd elk
  3. build Docker image: docker build .
  4. create local storage directory for settings: mkdir elk-storage
  5. adjust permissions of storage dir: sudo chown 911:911 ./elk-storage
  6. start container: docker-compose up -d

[!NOTE] The provided Dockerfile creates a container which will eventually run Elk as non-root user and create a persistent named Docker volume upon first start (if that volume does not yet exist). This volume is always created with root permission. Failing to change the permissions of /elk/data inside this volume to UID:GID 911 (as specified for Elk in the Dockerfile) will prevent Elk from storing it's config for user accounts. You either have to fix the permission in the created named volume, or mount a directory with the correct permission to /elk/data into the container.

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

📲 PWA

You can consult the PWA documentation to learn more about the PWA capabilities on Elk, how to install Elk PWA in your desktop or mobile device and some hints about PWA stuff on Elk.

🦄 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 yet powerful syntax highlighter
  • vite-plugin-pwa - Prompt for update, Web Push Notifications and Web Share Target API

👨‍💻 Contributors

📄 License

MIT © 2022-PRESENT Elk contributors