Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2024-11-16 17:07:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update Getting Started

Browse source
This commit is contained in:
Luke Parker 2023-03-25 01:44:07 -04:00
parent d954e67238
commit 839734354a
No known key found for this signature in database
1 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/Getting Started.md
View file

@ -1,6 +1,6 @@
# Getting Started
## Run Serai Node Locally
### System Dependencies
### Dependencies
##### Ubuntu
@ -26,6 +26,7 @@ brew install rustup
```
rustup update
rustup toolchain install stable
rustup toolchain install nightly
rustup target add wasm32-unknown-unknown --toolchain nightly
```
@ -62,7 +63,11 @@ cargo build --release
### Run Tests
Running tests requires a Monero regtest node running in the background.
Running tests requires:
- A Bitcoin regtest node
- A Monero regtest node
- A monero-wallet-rpc instance
```
cargo test --all-features
@ -74,9 +79,11 @@ cargo test --all-features
./target/release/serai-node --dev
```
## Run Serai with Orchestration
### Run Serai with Orchestration
In the deploy directory, you can find our orchestration components for running the entire infrastructure of Serai in a local environment using Docker Compose or Kubernetes.
Under `/deploy`, you can find our orchestration components for running the
entire infrastructure of Serai in a local environment using Docker Compose or
Kubernetes.
[Run Serai with Docker Compose](../deploy/README.md)