The Audius Monorepo
🎧🎸🎹🤘🎶🥁🎷🎻🎤🔊

Audius is a decentralized, community-owned music-sharing protocol

For details on operating an Audius service, getting started with the Token and the API, see docs.audius.org.

Packages

Name	Description
web	Web and desktop apps
mobile	Mobile app
embed	Embed player that renders on third party sites (like X and Discord)
sdk	The @audius/sdk typescript SDK
harmony	The Audius design system
common	Shared code between web and mobile
identity-service	Audius auth library
commands	CLI to perform actions against the dev stack
compose	Defines dependencies for audius-compose
eslint-config-audius	Shared lint configuration
spl	Handles Solana instructions for the Audius programs
eth	Handles interactions for the Audius Ethereum Governance & Staking Contracts

Required Dependencies

We recommend using homebrew to install the dependencies required to run Audius:

brew install nvm pyenv rbenv homebrew/cask/docker docker-compose

You will need to add some shell configuration for nvm, pyenv, and rbenv. Please refer to the respective documentation and the installation output

Getting Started

npm install

This will do the following:

• Install the correct versions of node, ruby, and python
• Install dependencies (npm packages, gems, pods, etc.)
• Set up command line tools for interacting with the protocol (dev-tools/README.md)
• Initialize git hooks

Running the Protocol

npm run protocol

For more details and troubleshooting please refer to dev-tools/README.md

Running the Apps

Environments:

• \*:dev runs against local services
• \*:stage runs against the staging testnet
• \*:prod runs against production infrastructure

For example:

npm run web:prod

For all available commands please see the package.json scripts and the relevant package READMEs.

Contributing

We welcome contributions to Audius from anyone who opens a PR. Feel free to reach out to our team on Discord or via other channels for feedback and/or support!

Security

Please report security issues to [email protected] with a description of the vulnerability and any steps to reproduce. Details on our bug bounty program are available at audius.org/security

License

Apache 2.0: LICENSE file