From 5bbca075e896c48c338cb6a6757f0899eefe3959 Mon Sep 17 00:00:00 2001 From: gearnode Date: Mon, 10 Mar 2025 10:09:52 +0100 Subject: [PATCH] Update contributing intructions Signed-off-by: gearnode --- CONTRIBUTING.md | 16 ++++++++++++---- README.md | 5 +---- cfg/dev.yaml | 4 ++++ 3 files changed, 17 insertions(+), 8 deletions(-) create mode 100644 cfg/dev.yaml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc85ccc8a..309fdf189 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,6 @@ # Contributing -Thank you for your interest in contributing to our project! + +Thank you for your interest in contributing to our project! ## How to Contribute @@ -20,7 +21,6 @@ project. DCO is a legally binding statement that asserts that you are the creator of your contribution and that you wish to allow us to use it in this project. - When you contribute to this repository with a pull request, you need to sign-off that you agree to the DCO. You do this by adding a `Signed-off-by` line to your commit messages containing your name and @@ -46,6 +46,7 @@ Signed-off-by: John Doe ## Development Setup ### Prerequisites + - Go 1.21+ - Node.js 22+ - Docker @@ -53,35 +54,41 @@ Signed-off-by: John Doe ### 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: +6. Start the development servers: + ```bash # In one terminal - start the API server - bin/probod + bin/probod -cfg-file cfg/dev.yaml # In another terminal - start the frontend npm -w @probo/console run dev @@ -92,6 +99,7 @@ The application should now be running at `http://localhost:3000` ## Need Help? Create an issue if you: + - Found a bug - Have a feature request - Need help with something diff --git a/README.md b/README.md index f9d975c36..e1fa7c86a 100644 --- a/README.md +++ b/README.md @@ -75,11 +75,8 @@ Probo is designed to be accessible, transparent, and community-driven. # Build the project make build - # In one terminal - start the API server + # Start the application bin/probod - - # In another terminal - start the frontend - npm -w @probo/console run dev ``` The application will be available at: diff --git a/cfg/dev.yaml b/cfg/dev.yaml new file mode 100644 index 000000000..4d1784ef6 --- /dev/null +++ b/cfg/dev.yaml @@ -0,0 +1,4 @@ +probod: + api: + cors: + allowed-origins: ["http://localhost:3000"]