Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nodeful authored May 8, 2021
1 parent e696e15 commit d6a3f5c
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,23 @@ If you want to run the web based User Interface locally then you need to follow
#### Prerequisites
Install [Node.js](https://nodejs.org/en/) LTS version preferrably using [NVM](https://github.com/nvm-sh/nvm#installing-and-updating)

Install [Yarn](https://classic.yarnpkg.com/en/) v1 globally: `npm i -g yarn` (this is needed because the project uses [Yarn Workspaces](https://classic.yarnpkg.com/en/docs/workspaces/))

#### Building and running the Web UI
1. Go into the ui/ directory by `cd ui/`
2. Install Node dependencies with `npm install`
3. Start local development server with `npm start`
1. Run `yarn` from the root directory of the Monorepo
2. Go into the ui/ directory by `cd ui/`
3. Start local development server with `yarn start`

### Native app + driver
#### Prerequisites

1. Download [Xcode](https://apps.apple.com/us/app/xcode/id497799835?mt=12)
2. Install [CocoaPods](https://cocoapods.org/) by `sudo gem install cocoapods`
3. Install [Carthage](https://github.com/Carthage/Carthage#installing-carthage) by `brew update && brew install carthage`

#### Building and running the App

1. Go into the native/app directory from root of the repo by: `cd native/app/`
1. Go into the native/app directory from root of the repo by: `cd native/`
2. Install Cocoapod dependencies: `pod install`
3. Install Carthage dependencies: `carthage update`
4. Go back to the native/ directory: `cd ../`
5. Open the Xcode workspace: `open eqMac.xcworkspace`
6. Launch eqMac in debug mode by running the **App - Debug** Scheme:
3. Open the Xcode workspace: `open eqMac.xcworkspace`
4. Launch eqMac in debug mode by running the **App - Debug** Scheme:
<img width="512" src="https://user-images.githubusercontent.com/8472525/83069640-279c1100-a062-11ea-85a7-45aa5253771b.png"/>

0 comments on commit d6a3f5c

Please sign in to comment.