react-native/local-cli/templates
Martin Konicek a54d449e94 CLI: Add support for project templates
Summary:
Currently it is not trivial for people to get started with React Native. `react-native init MyApp` just creates a simple app with a single screen. People have to spend time figuring out how to add more screens, or how to accomplish very basic tasks such as rendering a list of data or handling text input.

Let's add an option: `react-native init --template navigation` - this creates a "starter" app which can be easily tweaked into the actual app the person wants to build.

**Test plan (required)**

- Checked that 'react-native init MyApp' still works as before:

<img width="487" alt="screenshot 2017-02-02 16 56 28" src="https://cloud.githubusercontent.com/assets/346214/22559344/b2348ebe-e968-11e6-9032-d1c33216f490.png">

<img width="603" alt="screenshot 2017-02-02 16 58 04" src="https://cloud.githubusercontent.com/assets/346214/22559370/c96a2ca6-e968-11e6-91f7-7afb967920fc.png">

- Ran 'react-native init MyNavApp --template'. This prints the available templates:

```
$ react-native init MyNavApp
Closes https://github.com/facebook/react-native/pull/12170

Differential Revision: D4516241

Pulled By: mkonicek

fbshipit-source-id: 8ac081157919872e92947ed64ea64fb48078614d
2017-02-06 12:31:25 -08:00
..
HelloNavigation CLI: Add support for project templates 2017-02-06 12:31:25 -08:00
HelloWorld Eject CLI command to re-create native folders 2017-02-03 12:58:46 -08:00
README.md CLI: Add basic Navigation template (Chat) 2017-02-02 03:28:35 -08:00

README.md

App templates

This folder contains basic app templates. These get expanded by 'react-native init' when creating a new app to make it easier for anyone to get started.

Chat Example

This is an example React Native app demonstrates ListViews, text input and navigation between a few screens.

screenshot 2017-01-13 17 24 37 screenshot 2017-01-13 17 24 40

Purpose

One problem with React Native is that it is not trivial to get started: react-native init creates a very simple app that renders some text. Everyone then has to figure out how to do very basic things such as adding a list of items fetched from a server, navigating to a screen when a list item is tapped, or handling text input.

This app is a template used by react-native init so it is easier for anyone to get up and running quickly by having an app with a few screens, a ListView and a TextInput that works well with the software keyboard.

Best practices

Another purpose of this app is to define best practices such as:

  • The folder structure of a standalone React Native app
  • A style guide for JavaScript and React - for this we use the AirBnb style guide
  • Naming conventions

We need your feedback to settle on a good set of best practices. Have you built React Native apps? If so, please use the issues in the repo mkonicek/ChatExample to discuss what you think are the best practices that this example should be using.

Running the app locally

cd ChatExample
yarn
react-native run-ios
react-native run-android

(In case you want to use react-navigation master):

# Install dependencies:
cd react-navigation
yarn
yarn pack --filename react-navigation-1.0.0-alpha.tgz
cd ChatExample
yarn
yarn add ~/code/react-navigation/react-navigation-1.0.0-alpha.tgz