diff --git a/docs/nix_dev_env.md b/docs/nix_dev_env.md --- a/docs/nix_dev_env.md +++ b/docs/nix_dev_env.md @@ -34,6 +34,11 @@ To install and configure the [Nix package manager](https://nixos.org), please run: ``` +# Pull down git repository +git clone git@github.com:CommE2E/comm.git +cd comm + +# Install Nix and Comm binary cache ./scripts/install_nix.sh ``` @@ -67,6 +72,7 @@ ## Development workflows - [Web workflows](./nix_web_workflows.md#development) + - [Download yarn dependencies](./nix_web_workflows.md#download-yarn-dependencies) - [Flow typechecker](./nix_web_workflows.md#flow-typechecker) - [Running keysever](./nix_web_workflows.md#running-keyserver) - [Running web app](./nix_web_workflows.md#running-web-app) @@ -76,6 +82,7 @@ - [Redux Developer Tools](./nix_web_workflows.md#redux-developer-tools) - [Debugging JavaScript](./nix_web_workflows.md#debugging-javascript) - [Mobile workflows](./nix_mobile_workflows.md#mobile-workflows) + - [Download yarn dependencies](./nix_mobile_workflows.md#download-yarn-dependencies) - [Running mobile app on iOS Simulator](./nix_mobile_workflows.md#running-mobile-app-on-ios-simulator) - [Running mobile app on Android Emulator](./nix_mobile_workflows.md#running-mobile-app-on-android-emulator) - [Running mobile app on physical iOS devices](./nix_mobile_workflows.md#running-mobile-app-on-physical-ios-devices) diff --git a/docs/nix_mobile_workflows.md b/docs/nix_mobile_workflows.md --- a/docs/nix_mobile_workflows.md +++ b/docs/nix_mobile_workflows.md @@ -1,5 +1,14 @@ # Mobile workflows +## Download yarn dependencies + +Yarn installation will install react native and many other needed dependencies used +by all workflows: + +``` +yarn cleaninstall +``` + ## Running mobile app on iOS Simulator First, make sure that the keyserver is running. If you haven’t already, run: diff --git a/docs/nix_web_workflows.md b/docs/nix_web_workflows.md --- a/docs/nix_web_workflows.md +++ b/docs/nix_web_workflows.md @@ -1,5 +1,14 @@ # Development +## Download yarn dependencies + +Yarn installation will install react native and many other needed dependencies used +by all workflows: + +``` +yarn cleaninstall +``` + ## Flow typechecker It’s good to run the `flow` typechecker frequently to make sure you’re not introducing any type errors. Flow treats each Yarn Workspace as a separate environment, and as such runs a separate type-checking server for each.