Skip to content

fixed CONTRIBUTING.md instructions #24

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

Open
ShiraiEd wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fixed CONTRIBUTING.md instructions #24

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
14 changes: 9 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,15 @@ Thanks for your interest in contributing. Here's how to get started.
## Setup

1. Fork the repo and clone your fork
2. Install Rust 1.85+ via [rustup](https://rustup.rs)
3. Install PostgreSQL 16+ (or use Docker: `docker compose up db -d`)
4. Copy `.env.example` to `.env` and configure your database
5. Run `cargo run` to start the server
6. Run `cargo test` to run the test suite
2. In the root directory run `git remote add upstream https://github.com/zaptech-dev/reeverb`
3. Install Rust 1.85+ via [rustup](https://rustup.rs)
4. Install PostgreSQL 16+ (or use Docker: `docker compose up db -d`)
5. Copy `.env.example` to `.env` and configure your database
6. Run `cargo install trunk`
7. Run `rustup target add wasm32-unknown-unknown`
8. `cd` into `reeverb/crates/dashboard` and run `trunk build`
9. Go back to the root directory and run `cargo run` to start the server
10. Run `cargo test` to run the test suite

## Pull Requests

Expand Down
Loading