Skip to content

Add prerequisites for project setup #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jnakaigen wants to merge 1 commit into from
Closed

Add prerequisites for project setup #289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
Loading