Update contributing intructions

Signed-off-by: gearnode <bryan@frimin.fr>
This commit is contained in:
gearnode
2025-03-10 10:09:52 +01:00
parent f74cb3b7d7
commit 5bbca075e8
3 changed files with 17 additions and 8 deletions

View File

@@ -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 <john.doe@example.org>
## Development Setup
### Prerequisites
- Go 1.21+
- Node.js 22+
- Docker
@@ -53,35 +54,41 @@ Signed-off-by: John Doe <john.doe@example.org>
### 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

View File

@@ -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:

4
cfg/dev.yaml Normal file
View File

@@ -0,0 +1,4 @@
probod:
api:
cors:
allowed-origins: ["http://localhost:3000"]