audius.co • docs.audius.co

Audius is the community-run music platform and developer gateway to the internet's largest open music catalog, the Open Audio Protocol.

Packages

Name	Description
web	Web and desktop app
mobile	iOS and Android app
embed	Embed player for third-party sites (X, Discord, etc.)
sdk	@audius/sdk — TypeScript SDK for the Audius protocol
harmony	Audius design system
common	Shared state, models, and utilities for web and mobile
spl	Solana program instructions for Audius
eth	Ethereum governance and staking contract interactions
fixed-decimal	Fixed-point decimal math utilities
identity-service	Auth and identity service
commands	CLI for performing actions against the dev stack
compose	audius-compose service definitions
eslint-config-audius	Shared ESLint configuration

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 Apps

Environments:

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

For example:

npm run web

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 security@audius.co 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