Skip to content
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.

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

Debian startup readme #200

Merged
merged 2 commits into from
Dec 7, 2023
Merged
Changes from all commits
Commits
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
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,40 @@ There are plans for many more services in the future.
To learn more, see our [future plans](##Current-and-Future-State).

## Contributing
To contribute to the project, create branches off the repository itself (don't fork into your own namespace) and open PR's against the main branch. All PR's are subject to review. To run the project in development, execute the following commands:
To contribute to the project, create branches off the repository itself (don't fork into your own namespace) and open PR's against the main branch. All PR's are subject to review.

### Basic Setup

To construct the environment and run the project in development, you'll need to install a few things:

* Rust
* Docker (installed and running)
* Possibly MongoDB

### Debian Bullseye Specific Setup

A couple steps that are specific to Debian Bullseye, but which may or may not be relevant to other systems.

First install a couple requirements:

````
sudo apt install -y gcc libssl-dev pkg-config
````

Secondly, we need to be able to run Docker without root:

```
sudo usermod -a -G docker user
```

### Finally

```
cargo install cargo-shuttle
cargo install trunk // make sure to run these to installs separately
rustup target add wasm32-unknown-unknown
cargo shuttle run
```
You must also have Docker installed and running to construct the environment. You may also need to install MongoDB.

## Current and Future State
This repo (and STS as a whole) are still growing rapidly.
Expand Down
Loading