mirror of
https://github.com/elk-zone/elk.git
synced 2024-11-19 07:19:58 +00:00
31 lines
1.4 KiB
Markdown
31 lines
1.4 KiB
Markdown
# Elk
|
|
|
|
|
|
|
|
A nimble Mastodon web client made with 🧡
|
|
|
|
Elk is in early alpha, but it is already quite usable. We would love your feedback and contributions.
|
|
|
|
Check out the [Open Issues](https://github.com/elk-zone/elk/issues) and jump in the action. Join the [Elk discord server](https://discord.gg/vAZSDU9J) to learn more and get involved!
|
|
|
|
The client is deployed to [elk.zone](https://elk.zone), you can share screenshots on social media but avoid sharing this URL or the discord server until we open the repo.
|
|
|
|
If you would like to contribute, until the repo is open, please create branches in the main repository and send a PR from there.
|
|
|
|
# Stack
|
|
|
|
- [Vite](https://vitejs.dev/) - Next Generation Frontend Tooling
|
|
- [Nuxt](https://nuxtjs.org/) - The Intuitive Vue Framework
|
|
- [Vue](https://vuejs.org/) - The Progressive JavaScript Framework
|
|
- [VueUse](https://vueuse.org/) - Collection of Vue Composition Utilities
|
|
- [Pinia](https://pinia.vuejs.org/) - The Vue Store that you will enjoy using
|
|
- [Vue Macros](https://vue-macros.sxzz.moe/) - More macros and syntax sugar for Vue
|
|
- [UnoCSS](https://uno.antfu.me/) - The instant on-demand atomic CSS engine
|
|
- [Iconify](https://github.com/iconify/icon-sets#iconify-icon-sets-in-json-format) - Iconify icon sets in JSON format
|
|
- [Masto.js](https://neet.github.io/masto.js) - Mastodon API client in TypeScript
|
|
- [shiki](https://shiki.matsu.io/) - A beautiful Syntax Highlighter
|
|
|
|
# License
|
|
|
|
MIT
|