docs: adds instruction to run the projects

eduardomoroni · Nov 6, 2018 · 5db9f56 · 5db9f56
1 parent e9f72e3
commit 5db9f56
Show file tree

Hide file tree

Showing 9 changed files with 78 additions and 105 deletions.
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v8.12.0
diff --git a/README.md b/README.md
@@ -79,6 +79,9 @@ This repository contains 2 examples of how to implement react following clean ar
 ```
 *Note:* frameworks folder is basically framework setup to have it available to the adapters.  
 
+## How to Run
+run `npm install` under the project you'd like to run, and then run `npm start`.
+
 ## References
 - [Clean Architecture: a craftsman's guide to software structure and design](https://goo.gl/2h3fsD)
 - [The clean architecture](https://8thlight.com/blog/uncle-bob/2012/08/13/the-clean-architecture.html)

diff --git a/authentication/native/package.json b/authentication/native/package.json
@@ -4,7 +4,8 @@
   "author": "eduardomoroni",
   "license": "MIT",
   "scripts": {
-    "preinstall": "cd ../core && npm run build",
+    "preinstall": "cd ../core && npm install",
+    "postinstall": "cd ../core && npm run build",
     "start": "node node_modules/react-native/local-cli/cli.js start",
     "ios": "react-native run-ios",
     "android": "react-native run-android"

diff --git a/authentication/web/README.md b/authentication/web/README.md
@@ -3,6 +3,10 @@ This project was bootstrapped with [Create React App](https://github.com/faceboo
 Below you will find some information on how to perform common tasks.<br>
 You can find the most recent version of this guide [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md).
 
+## How to run
+- `npm install` will install both this project dependencies and `../core` dependencies.
+- `npm start` will build core module and run this project.
+
 ## Table of Contents
 
 - [Updating to New Releases](#updating-to-new-releases)

diff --git a/authentication/web/package.json b/authentication/web/package.json
@@ -4,7 +4,8 @@
   "author": "eduardomoroni",
   "license": "MIT",
   "scripts": {
-    "preinstall": "cd ../core && npm run build",
+    "preinstall": "cd ../core && npm install",
+    "prestart": "cd ../core && npm run build",
     "start": "react-scripts-ts start"
   },
   "dependencies": {

diff --git a/counter/native/package.json b/counter/native/package.json
@@ -4,7 +4,8 @@
   "author": "eduardomoroni",
   "license": "MIT",
   "scripts": {
-    "preinstall": "cd ../core && npm run build",
+    "preinstall": "cd ../core && npm install",
+    "postinstall": "cd ../core && npm run build",
     "start": "node node_modules/react-native/local-cli/cli.js start",
     "ios": "react-native run-ios",
     "android": "react-native run-android"

diff --git a/counter/web/README.md b/counter/web/README.md
@@ -3,6 +3,10 @@ This project was bootstrapped with [Create React App](https://github.com/faceboo
 Below you will find some information on how to perform common tasks.<br>
 You can find the most recent version of this guide [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md).
 
+## How to run
+- `npm install` will install both this project dependencies and `../core` dependencies.
+- `npm start` will build core module and run this project.
+
 ## Table of Contents
 
 - [Updating to New Releases](#updating-to-new-releases)

diff --git a/counter/web/package.json b/counter/web/package.json
@@ -4,7 +4,8 @@
   "author": "eduardomoroni",
   "license": "MIT",
   "scripts": {
-    "preinstall": "cd ../core && npm run build",
+    "preinstall": "cd ../core && npm install",
+    "prestart": "cd ../core && npm run build",
     "start": "react-scripts-ts start"
   },
   "dependencies": {