Skip to content

Add Setup Script (Frontend, Backend, Syncserver via Tmux) #155

@its-me-abhishek

Description

@its-me-abhishek

Is your feature request related to a problem? Please describe.
Currently, contributors need to run multiple servers (frontend, backend, syncserver) manually in separate terminals or rely on Docker/Kubernetes, which may not always be convenient for local testing.

Describe the solution you'd like
Create a setup script (e.g., setup.sh) that automatically runs all three components using Tmux. Should be placed in a new Directory named as development. Do include a README with reference to Documentation, and the environment variables required. Tell about all pre requisites to run it locally (npm, tmux, etc.)

For example:

tmux new-session -d -s ccsync "cd backend && flask run"
tmux split-window -h "cd frontend && npm start"
tmux split-window -v "docker-compose up syncserver"
tmux attach -t ccsync

Describe alternatives you've considered

  • A Makefile with individual commands for each service
  • Using a simple Python script to spawn subprocesses but it might be too complex and adds yet another dependency

Additional context
This will make local development much faster and reduce setup friction for new contributors.

Metadata

Metadata

Labels

backendSomething isn't working on the backendfrontendSomething isn't working on the frontendgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions