/rndm-react-xp

A quick start, simple and usable template for building cross-platform applications with React, React Native and React Native Web.

Primary LanguageJavaScript

RNDM React XP

About

This template is a simple and usable template for building cross-platform applications with React, React Native and React Native Web.

Upon installation, the template will run immediately on iOS, Android and Web natively.

Requirements

Before running this project you should have the correct environment set up for the devices you will be targeting. For a full guide on this process you can follow the setup instructions on the React Native website

https://facebook.github.io/react-native/docs/getting-started.html

You can also checkout this medium blog:

https://medium.com/@MadApper/react-native-setting-up-the-environment-5c310ef814d5

For Windows Environment you can follow the below article:

https://shift.infinite.red/getting-started-with-react-native-development-on-windows-90d85a72ae65

Installation

From Git

If you are installing from git, you clone the repo from:

https://github.com/rndm-com/rndm-react-xp

From rndm-cli

If you have already installed our rndm-cli package, then you can take advantage of the init method to easily create your new project.

Click here for full instructions on this package >

Usage

The template is extremely simple to set up and deploy.

Installation

Command:

npm install

Description: Installs all the relevant dependencies for each platform.

Be patient as this can take a little time!

Running

Web

Command:

npm run web

Description: Compiles all the web dependencies and launches a browser to begin running your code. This uses watchman to determine when there are changes and will update the project accordingly.

Native

Command:

npm run packager

Description: Since the iOS and Android platforms run their native code independently from the JavaScript code, we have separated the packager element away from the native compilation. When you run the packager, it bundles the JavaScript code ready to be used by either Android or iOS. You will need to follow this up with the next command for the native platform you require.

Please Note: The next command should be run in a different tab/instance of your terminal.

iOS

Command:

npm run ios

Description: Compiles the native iOS code and opens the iOS Simulator.

tvOS

tvOS requires a little more setup to allow the easy running from command-line.

Installation

npm install -g ios-sim

Command:

npm run tvos

Description: Compiles the native tvOS code and opens the tvOS Simulator.

Android

Command:

npm run android

Description: Compiles the native Android code.

Please Note: You need to have a connected android Emulator or device in order to run the Android code.

(BETA) Windows 10, Windows 10 Phone, Xbox

This is still undergoing testing. If you are a windows user and would like to contribute to this project, your input will be much appreciated!

Command:

npm run windows

Description: Compiles the native Windows UWP code.

Please Note: This requires a windows environment to run.