---

 
 Development 
     
 Contribution 
     
 Wiki 
   

_{// Project Overview}

Zephyr is a Social aggregator, part social media platform, part news aggregator. It is a platform that allows users to share and discover content from around the web. Completly open-source and community-driven, Zephyr is a platform that is built by the community, for the community.

_{// Development Setup (For Contributers)}

_{// Prerequisites}

• Node.js (v20 or higher)
• pnpm
• Turborepo

_{// Installation}

We use **pnpm** and **turbo** for managing the dependencies and the monorepo structutre. To install the dependencies and start the development server, run the following commands:

Important

Make sure you have the prerequisites installed before running the following commands and have .env file in the root directory.

# Clone the repository
git clone https://github.com/zephyr.git && cd zephyr
# Install the dependencies
pnpm install
# Start the development server on http://localhost:3000 (default web) and http://localhost:3001 (default wiki)
turbo dev

_{// Docker:}

# Build the docker image for production and start the server
docker-compose -f docker-compose.yml up -d or docker-compose build and docker-compose up

_{// License}

Zephyr is licensed under the AGPL License.

 
 🡅 
 

---