Note
This repository is a part of Hacktoberfest 2024. So Issues and PRs are welcome. As the porject is in very early stage, we are looking for contributors to help us build the platform. If you are interested in contributing or have any questions / suggestions, feel free to open an issue or a PR. We are looking forward to working with you. 🚀
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.
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# 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
Zephyr is licensed under the AGPL License.