An open API service indexing awesome lists of open source software.

https://github.com/dezh-tech/jellyfish

The JellyFish Nostr services wesite.
https://github.com/dezh-tech/jellyfish

jellyfish nostr

Last synced: 16 days ago
JSON representation

The JellyFish Nostr services wesite.

Awesome Lists containing this project

README

          

# 🪼 JellyFish

**JellyFish** is a suite of Nostr services developed by [Dezh Technologies](https://github.com/dezh-tech) 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.

## 🌐 Live Demo

Explore the live JellyFish interface:

👉 [jellyfish.land](https://jellyfish.land)

## 🧩 Ecosystem Components

JellyFish integrates with several key components within the Dezh Technologies ecosystem:

- **[Immortal](https://github.com/dezh-tech/immortal)**: An advanced Nostr relay implementation.
- **[Panda](https://github.com/dezh-tech/panda)**: A Nostr client designed for seamless interaction.
- **[Kraken](https://github.com/dezh-tech/kraken)**: A manager service to oversee the JellyFish software stack.
- **[Sea-Snail](https://github.com/dezh-tech/sea-snail)**: An advanced Nostr NIP-05 server.
- **[AlienOS](https://github.com/dezh-tech/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.

## 🚀 Getting Started

### Prerequisites

Ensure you have the following installed:

- **Node.js** (v16 or higher)
- **npm** (v7 or higher)

### Installation

1. **Clone the repository:**

```bash
git clone https://github.com/dezh-tech/jellyfish.git
cd jellyfish
```

2. **Install dependencies:**

```bash
npm install
```

3. **Start the development server:**

```bash
npm run dev
```

## 🛠️ Project Structure

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.

## 📦 Scripts

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.

## 📄 License

This project is licensed under the [MIT License](LICENSE).

## Donations

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](lightning:donate@dezh.tech)**
- 🟠 **On-Chain**: **[bc1qfw30k9ztahppatweycnll05rzmrn6u07slehmc](bitcoin:bc1qfw30k9ztahppatweycnll05rzmrn6u07slehmc)**

Your support helps us build better tools for the decentralized web. Thank you!

## 🤝 Contributing

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.

## 📫 Contact

For questions or support:

- 📧 Email: **[hi@dezh.tech](mailto:hi@dezh.tech)**
- 🟣 Nostr: **[\_@jellyfish.land](nostr:npub1hu47u55pzjw8cdg0t5f2uvh4znrcvnl3pqz3st6p0pfcctzzzqrsplc46u)**
- 💬 Or open an issue on the [GitHub repository](https://github.com/dezh-tech/jellyfish/issues)