https://github.com/nimbus-town/nimbus
A nimble Bluesky web client
https://github.com/nimbus-town/nimbus
bsky-client nuxt-app
Last synced: 2 days ago
JSON representation
A nimble Bluesky web client
- Host: GitHub
- URL: https://github.com/nimbus-town/nimbus
- Owner: nimbus-town
- License: mit
- Created: 2024-11-22T20:27:21.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-03-13T03:45:48.000Z (about 2 months ago)
- Last Synced: 2025-04-30T17:06:28.080Z (9 days ago)
- Topics: bsky-client, nuxt-app
- Language: Vue
- Homepage:
- Size: 23.6 MB
- Stars: 121
- Watchers: 8
- Forks: 19
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - nimbus-town/nimbus - A nimble Bluesky web client (Vue)
- awesome - nimbus-town/nimbus - A nimble Bluesky web client (Vue)
README
Nimbus WIP
A nimble Bluesky web client
## ⚠️ Nimbus is Work In Progress
**Nimbus doesn't work at this point. It's just an idea and playground.**
We welcome PRs if you'd like to help and would like to play too.
## 🧑💻 Contributing
We're really excited that you're interested in contributing to Nimbus! Before submitting your contribution, please read through the following guide.
### Local Setup
Clone the repository and run on the root folder:
```
pnpm i --frozen-lockfile
pnpm run dev
```
`Warning`: you will need `corepack` enabled, check out the [Nimbus Contributing Guide](./CONTRIBUTING.md) for a detailed guide on how to set up the project locally.
### Testing
Nimbus uses [Vitest](https://vitest.dev). You can run the test suite with:
```
pnpm test
```
## 📲 PWA
You can consult the [PWA documentation](https://docs.nimbus.town/pwa) to learn more about the PWA capabilities on Nimbus, how to install Nimbus PWA in your desktop or mobile device and some hints about PWA stuff on Nimbus.
## 🦄 Stack
- [Vite](https://vitejs.dev/) - Next Generation Frontend Tooling
- [Nuxt](https://nuxt.com/) - The Intuitive Web 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
- [shiki](https://shiki.style/) - A beautiful yet powerful syntax highlighter
- [vite-plugin-pwa](https://github.com/vite-pwa/vite-plugin-pwa) - Prompt for update and Web Share Target API
- Elk was built using [Masto.js](https://neet.github.io/masto.js), Mastodon API client in TypeScript.
## Elk
Nimbus is a fork of [Elk](https://github.com/elk-zone/elk). We're leaving their sponsors and contributors section in the readme as a token of gratitude.
## 💖 Sponsors
We are grateful for the generous sponsorship and help of:
And all the companies and individuals sponsoring the Elk Team and the members. If you're enjoying the app, consider sponsoring them:
- [Elk Team's GitHub Sponsors](https://github.com/sponsors/elk-zone)
We would also appreciate you sponsoring other contributors to Bluesky and 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.
## 👨💻 Contributors
## 📄 License
[MIT](./LICENSE) © 2022-PRESENT Elk contributors, 2024-PRESENT Nimbus contributors