Fork Guide
Self-host OpenSync by forking the repository and deploying your own instance.Why Fork?
- Data ownership - Keep all data in your own Convex instance
- Customization - Modify features to fit your workflow
- Privacy - Run entirely on your infrastructure
- Learning - Study and modify the codebase
Quick Fork
1
Fork on GitHub
Visit
github.com/waynesutton/opensync
and click Fork.
2
Clone locally
bash git clone https://github.com/YOUR_USERNAME/opensync cd opensync 3
Install dependencies
bash npm install 4
Start Convex
bash npx convex dev This creates a new Convex project linked to your
account.5
Start frontend
bash npm run dev Project Structure
Local Development
Backend + Frontend
Run both in separate terminals:Environment Setup
Create.env.local: