Development 
     
 Contributing 
     
 Roadmap 
     
 Singularity Works 
     
 Troubleshoot 
   

_{// About 🌿}

Zephyr is a social platform designed for seamless interaction, privacy, and speed. Built with modern web technologies, Zephyr redefines how users connect, share, and engage in a clutter-free digital space. Whether it's real-time conversations, media sharing, or a smooth user experience, Zephyr is crafted for the future of social networking.

About Zephyr - Aggregate social posts in one place - Open Source & contributor friendly - Supports diverse file formats - Bookmark posts from other platforms - Earn & grow Aura (reputation / token system)
	Zeph AI (WIP) - Context‑aware assistant mascot - Chat + post generation & refinement - Smart summaries & replies - Helpful guidance & interactions

_{// Rebranding & Info 🦕}

With Zephyr's enhancement from Singularity Works, we are excited to announce a renewed focus on enhancing user experience & performance.

btw here are some cool artworks for our collaboration:

_{Artwork by the Singularity Works team}

_{// Local Development Setup 📐}

Note

Zephyr is a monorepo project, which means that it is composed of multiple packages that are managed together. The project uses bun for workspace management and Docker for containerization. Make sure you have the following prerequisites installed before setting up the development environment.

_{Manual Installation}

# 1. Clone the repository
git clone https://github.com/zephverse/zephyr && cd zephyr

# 2. Install the dependencies
bun install

# 3. First time setup or after clean
# This will start required containers and run migration containers required for prisma schema & minio buckets
bun run docker:dev
# Clean everything and start fresh if you encounter any issues
bun run docker:clean && bun run docker:dev

# 4. Setup the environment variables automatically
bun run env:dev

# 5. Start the development server
bun run dev
# or
turbo dev

# If you encounter any issues, refer to the troubleshooting section below or report the issue on the Issues page

What a sucessful docker setup looks like after running bun run docker:dev:

_{// Ports:}

If everything goes well, you should be able to access the following services:

• Zephyr web: http://localhost:3000
• Zephyr auth: http://localhost:3001
• PostgreSQL: http://localhost:5433
• Redis: http://localhost:6379
• RedisInsight: http://localhost:5540
• Prisma Studio: http://localhost:5555
• MinIO Console: http://localhost:9001

_{// Troubleshooting 🍋‍🟩}

_{// pre commit hooks}

If you encounter any issues with the pre-commit hooks, try running the following commands:

# Ensure that your code is formatted and linted
bun run check

If you encounter any issues with the development setup, try the following steps:

_{// Database}

If you encounter any issues with Prisma or the migrations failed, try running the following commands:

# Navigate to the db package
cd packages/db && bun prisma generate

If you still encounter any issues with the development server, report the issue on the Issues page.

_{// Contributors}

_{// Our Services 🚀}

Zephyr Social media aggregator

Zeph AI (WIP) Your Companion for Zephyr

_{Copyright © 2025 Parazeeknova}

Zephyr is licensed under the AGPL License.