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.

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

Update development instructions #3476

Closed
wants to merge 1 commit into from
Closed

Update development instructions #3476

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
35 changes: 9 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,37 +65,20 @@ Packages for developers to run and test Audius

## Development

### Prerequisites

* Install docker & docker-compose [https://docs.docker.com/get-docker](https://docs.docker.com/get-docker)
* Install rust https://rustup.rs/
* Install nvm & node (v14.17.5) https://github.com/nvm-sh/nvm

### Running the protocol
```bash
git clone https://github.com/AudiusProject/audius-protocol.git
cd audius-protocol
# Add a line to your rc file of choice
# export PROTOCOL_DIR=$(pwd)

cd $PROTOCOL_DIR/service-commands
npm i
# This will install `A` to your command-line, an interface to the audius service-commands.
# Ensure ~/.local/bin is in your PATH
```
# initial setup
curl "https://raw.githubusercontent.com/AudiusProject/audius-protocol/master/dev-tools/setup.sh" | bash

# Install all dependencies
A init
# refresh terminal for docker
exit

# Run the entire stack
A up
# build and pull
audius-compose build # About 10 minutes
docker compose pull

# Run an individual service
A run discovery-provider up
A run discovery-provider down
audius-compose up # About 20 seconds
```

For more details on the `A` command and options, run `A --help` and checkout the service commands [README](https://github.com/AudiusProject/audius-protocol/tree/master/service-commands).


## Contributing

Expand Down