From cec6e12889c22dab91dd3220d695df93200e5f13 Mon Sep 17 00:00:00 2001 From: gearnode Date: Wed, 12 Feb 2025 17:20:01 -0800 Subject: [PATCH] Update contributing Signed-off-by: gearnode --- CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc5e475..bc85ccc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,6 +43,52 @@ Signed-off-by: John Doe - Follow existing code style - Update documentation if needed +## Development Setup + +### Prerequisites +- Go 1.21+ +- Node.js 22+ +- Docker + +### Installation Steps + +1. Clone the repository: + ```bash + git clone https://github.com/getprobo/probo.git + cd probo + ``` + +2. Install Go dependencies: + ```bash + go mod download + ``` + +3. Install JavaScript dependencies: + ```bash + npm ci + ``` + +4. Build the project: + ```bash + make build + ``` + +5. Start docker containers: + ```bash + make stack-up + ``` + +5. Start the development servers: + ```bash + # In one terminal - start the API server + bin/probod + + # In another terminal - start the frontend + npm -w @probo/console run dev + ``` + +The application should now be running at `http://localhost:3000` + ## Need Help? Create an issue if you: