From 2dbaef0a8517ad5da873c7629c35c8abf62c5af8 Mon Sep 17 00:00:00 2001 From: Preet538-neitzen <54236288+Preet538-neitzen@users.noreply.github.com> Date: Mon, 11 May 2020 02:18:27 +0530 Subject: [PATCH 1/2] Update README.md --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0a341ec..d2d4e0e 100644 --- a/README.md +++ b/README.md @@ -45,13 +45,14 @@ All the code is contained in the `src` directory, especially the 3 main entry fi ### Flux architecture actions/stores -All the [flux](https://facebook.github.io/flux) architecture is share to 100% to all the different builds. This means that all the logic and data management code is done only once and reuse everywhere. This allows us to have an easy tests suite as well and to ensure that our code is working properly on all the devices. +All the [flux](https://facebook.github.io/flux) architecture is share to 100% to all the different builds. This means that all the logic and data management code is done only once and reused everywhere. +This not only allows us to have an easy tests suite but also ensure that our code is working properly on all devices. ### Components -The real interest of the project is in how the components have been structured to shared most of their logic and only redefined what is specific to every device. +The real interest of the project is in how the components have been structured to share most of their logic and only redefine what is specific to every device. -Basically, every component has a main `Class` which inherits a base `Class` containing all the logic. Then, the main component import a different Render function which has been selected during the build. The file extension `.ios.js`, `.android.js` or `.js` is used by the build tool to import only the right file. +Basically, every component has a main `Class` which inherits a base `Class` containing all the logic. Then, the main component imports a different Render function which has been selected during the build. The file extension `.ios.js`, `.android.js` or `.js` is used by the build tool to import only the right file. The `.native.js` files contain code that is shared between both mobile platforms (iOS & Android). Currently, the `.ios.js` and `.android.js` files compose this `.native.js` file since all code is shared right now. However, if a component needed to be different for platform specific reasons, that code would be included in the corresponding platform specific files. @@ -93,10 +94,14 @@ Here are some thoughts about what can come next: ## Thank you Robert for your awesome design -I want to thank Robert O'Dowd who kindly authorized me the reuse his very beautiful design. The original design made by Robert was part of his project called "Simplifycation" visible [here](https://dribbble.com/shots/1973851-Simplifycation). +I want to thank Robert O'Dowd who kindly authorized me to reuse his very beautiful design. The original design made by Robert was part of his project called "Simplifycation" visible [here](https://dribbble.com/shots/1973851-Simplifycation). # How to build/run the projects +For ReactJS: +- `npm run build` to build the project. +- `npm run start` to run the project. + ## General requirements before running any specific project - `npm install` to install all the dependencies, React and React Native among others. From bc73e820d24c07afcd9afc55bc0997aaf187d98f Mon Sep 17 00:00:00 2001 From: Preet538-neitzen <54236288+Preet538-neitzen@users.noreply.github.com> Date: Mon, 11 May 2020 02:24:15 +0530 Subject: [PATCH 2/2] Update README.md Corrected grammatical mistakes and typos. Added information regarding how to build and start the project in reactJS environment because for new learners like me, this part could be tricky. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index d2d4e0e..0563276 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,10 @@ Some builds from npm included bugs while `npm install`. So if you are using a np ### Running the Mobile Apps +For setup and complete installtion guide visit : https://shift.infinite.red/getting-started-with-react-native-development-on-windows-90d85a72ae65 +For react-native: +- `react-native run-android` to start your application. + #### iOS - Open iosApp.xcodeproj and hit run in Xcode.