Skip to content

Commit

Permalink
Add dependencies, bundle to mobile README (#3111)
Browse files Browse the repository at this point in the history
  • Loading branch information
dharit-tan authored Mar 29, 2023
1 parent dc8d4f2 commit 6fe7abe
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,17 @@ This will do the following:
- Initialize git hooks (`npx @escape.tech/mookme init --only-hook --skip-types-selection`)
- Install ios pods

### Required Dependencies
The following dependencies are required to run the Audius client, and `npm install` will fail if they are not met. We recommend [homebrew](https://brew.sh/), [pyenv](https://github.com/pyenv/pyenv), and [rbenv](https://github.com/rbenv/rbenv). Don't forget to follow the instructions in the install command output (eg. adding things to your `.zshrc` or `bashrc` file).

```
brew install nvm pyenv rbenv
nvm install
pyenv install
rbenv install
```

### Running A Client

Environments:
Expand Down
6 changes: 5 additions & 1 deletion packages/mobile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ The Audius React Native mobile client
### Extra iOS Setup

```bash
# install cocoapods
# Install cocoapods using one of the below methods.
brew install cocoapods
sudo gem install cocoapods

cd ios
Expand All @@ -18,6 +19,9 @@ cd ..
## Running iOS

```bash
# Create the ios bundle. Should only have to run once.
npm run bundle:ios

# Run a simulator using a prod configuration
npm run ios
# Run a simulator using a stage configuration
Expand Down

0 comments on commit 6fe7abe

Please sign in to comment.