elk/README.md

31 lines
1.4 KiB
Markdown
Raw Normal View History

2022-11-23 13:06:27 +00:00
# Elk
2022-11-13 05:34:43 +00:00
2022-11-24 11:03:58 +00:00
![Elk Logo](https://elk.zone/logo.svg)
2022-11-24 10:53:23 +00:00
2022-11-27 15:03:09 +00:00
A nimble Mastodon web client made with 🧡
2022-11-13 05:34:43 +00:00
2022-11-24 10:46:03 +00:00
Elk is in early alpha, but it is already quite usable. We would love your feedback and contributions.
2022-11-24 10:53:23 +00:00
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!
2022-11-24 10:46:03 +00:00
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.
2022-11-24 10:53:23 +00:00
If you would like to contribute, until the repo is open, please create branches in the main repository and send a PR from there.
2022-11-24 11:03:58 +00:00
# Stack
2022-11-24 13:15:29 +00:00
- [Vite](https://vitejs.dev/) - Next Generation Frontend Tooling
2022-11-24 11:03:58 +00:00
- [Nuxt](https://nuxtjs.org/) - The Intuitive Vue Framework
2022-11-24 13:15:29 +00:00
- [Vue](https://vuejs.org/) - The Progressive JavaScript Framework
- [VueUse](https://vueuse.org/) - Collection of Vue Composition Utilities
2022-11-24 11:03:58 +00:00
- [Pinia](https://pinia.vuejs.org/) - The Vue Store that you will enjoy using
2022-11-24 13:15:29 +00:00
- [Vue Macros](https://vue-macros.sxzz.moe/) - More macros and syntax sugar for Vue
2022-11-24 11:03:58 +00:00
- [UnoCSS](https://uno.antfu.me/) - The instant on-demand atomic CSS engine
2022-11-24 13:15:29 +00:00
- [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
2022-11-24 11:03:58 +00:00
2022-11-24 10:53:23 +00:00
# License
MIT