From b240960d701669e3696ac577fb89e8a64fdaf25e Mon Sep 17 00:00:00 2001 From: Janaki Ratheesh <110283728+jnakaigen@users.noreply.github.com> Date: Sun, 21 Dec 2025 21:58:47 +0530 Subject: [PATCH] Add prerequisites for project setup Added prerequisites section with installation requirements for Go, Node.js, Docker, and Tmux. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index ee273a3f..d14e7962 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,15 @@ CCSync is composed of **three core modules**: 📖 Learn more in the [official documentation](https://its-me-abhishek.github.io/ccsync-docs/). +## Prerequisites + +Before setting up the project, ensure you have the following installed: + +- **Go (Golang):** Version 1.21 or higher (Required for Backend). +- **Node.js & npm:** Version 18 or higher (Required for Frontend). +- **Docker:** (Optional) Required only if you want to run the Sync Server or the full stack via `docker-compose`. +- **Tmux:** (Linux/macOS only) Required only if you use the `setup.sh` script. Windows users should follow the **Manual Setup** instructions. + ## Development Setup Want to contribute or run CCSync locally? We've made it easy!