JellyFish is a suite of Nostr services developed by Dezh Technologies aimed at enhancing user experience on the Nostr protocol. It serves as the frontend interface for the JellyFish ecosystem, integrating various components to provide a seamless and user-friendly experience.
Explore the live JellyFish interface:
JellyFish integrates with several key components within the Dezh Technologies ecosystem:
- Immortal: An advanced Nostr relay implementation.
- Panda: A Nostr client designed for seamless interaction.
- Kraken: A manager service to oversee the JellyFish software stack.
- Sea-Snail: An advanced Nostr NIP-05 server.
- AlienOS: A plugin-able and manageable Nostr stack designed for self-hosting.
These components work in harmony to provide a robust and scalable Nostr service platform.
Ensure you have the following installed:
- Node.js (v16 or higher)
- npm (v7 or higher)
-
Clone the repository:
git clone https://github.com/dezh-tech/jellyfish.git cd jellyfish -
Install dependencies:
npm install
-
Start the development server:
npm run dev
The project is organized as follows:
src/: Contains the main source code for the application.public/: Static assets served by the application.components.json: Configuration file for application components.vite.config.ts: Vite configuration file for build and development settings.
Commonly used npm scripts:
npm run dev: Start the development server.npm run build: Build the application for production.npm run preview: Preview the production build locally.npm run lint: Run ESLint to analyze code for potential issues.npm run format: Format code using Prettier.
This project is licensed under the MIT License.
If you find this project useful and would like to support continued development of JellyFish and other Dezh Technologies projects, consider donating:
- ⚡ Lightning Address: donate@dezh.tech
- 🟠 On-Chain: bc1qfw30k9ztahppatweycnll05rzmrn6u07slehmc
Your support helps us build better tools for the decentralized web. Thank you!
Contributions are welcome! Please fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.
For questions or support:
- 📧 Email: hi@dezh.tech
- 🟣 Nostr: _@jellyfish.land
- 💬 Or open an issue on the GitHub repository