nimbus

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 for a detailed guide on how to set up the project locally.

Testing

Nimbus uses Vitest. You can run the test suite with:

pnpm test

📲 PWA

You can consult the PWA documentation 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 - 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

• shiki - A beautiful yet powerful syntax highlighter

• vite-plugin-pwa - Prompt for update and Web Share Target API

• Elk was built using Masto.js, Mastodon API client in TypeScript.

Elk

Nimbus is a fork of 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

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 © 2022-PRESENT Elk contributors, 2024-PRESENT Nimbus contributors