node package manager

slush-react-native-ts-generator

Slush React Native TypeScript generator Build Status NPM version

Use this generator to create a basic React Native app with TypeScript support (ie. TSX).

This generator is based on the seed project ReactNativeTS

For info on using TSX

Editor/IDE

We recommend using Visual Studio Code with plugins:

Be sure to follow VSC Updates

Getting Started

Install slush-react-native-ts-generator globally:

$ npm install -g slush-react-native-ts-generator

Usage

Create a react-native app:

projects $ react-native init my-app

Run the generator from within the folder of the react-native app:

projects $ cd my-app
my-app $ slush react-native-ts-generator

Troubleshooting

If you get the error You must run this generator inside a project created with react-native-cli make sure you are running the generator from a folder with either an ios or android folder (or both).

These folders contain the native parts of your app for each supported native environment. The folders are (usually) generated by react-native CLI app generator)

Make sure you have a recent (2016+) react-native-cli binary installed globally.

$ npm uninstall -g react-native-cli
$ npm install -g react-native-cli

Slush

To find out more about Slush, check out the documentation.

WIP

The next step will be to add TypeScript sub-generators for:

  • Redux
  • ...

Suggestions and pull requests most welcome!!

Contributing

See the CONTRIBUTING Guidelines

Support

If you have any problem or suggestion please open an issue here.

License

The MIT License

Copyright (c) 2016, Kristian Mandrup

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.