Skip to content
This repository was archived by the owner on Oct 4, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
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
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@

| Name | Description |
| ----------------------------- | ---------------------------------------- |
| [`web`](./packages/web) | The decentralized Audius web application |
| [`web`](./packages/web) | The Audius web and desktop application |
| [`mobile`](./packages/mobile) | The Audius mobile application |
| [`stems`](./packages/stems) | The Audius client component library |
| [`common`](./packages/common) | Shared code between web and mobile |
| [`eslint-config-audius`](./packages/eslint-config-audius) | Shared lint configuration |

### Getting Started

Expand All @@ -40,3 +42,38 @@ This will do the following:
- Install root dependencies
- Install all package dependencies using `lerna bootstrap`
- Initialize git hooks (`npx @escape.tech/mookme init --only-hook --skip-types-selection`)

### Running A Client

Environments:

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

```bash
# web
npm run web:dev
npm run web:stage
npm run web:prod

# desktop
npm run desktop:dev
npm run desktop:stage
npm run desktop:prod

# mobile (append -- --device to target a physical device)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just tried this and it didn't default to my device. Only worked when I put -- --device "my iphone". The npm run ios:device command defaulted to the phone if connected

npm run ios:dev
npm run ios:stage
npm run ios:prod

npm run android:dev
npm run android:stage
npm run android:prod

# stems in watch mode
npm run stems

# common in watch mode
npm run common
```
Loading