Slush React Native TypeScript generator
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-ts
globally:
$ npm install -g slush-react-ts
Usage: React Native
The default
generator configures a React Native app for TypeScript
Create a react-native app using the CLI app generator:
projects $ react-native init my-app
Run the slush generator from within the folder of your react-native app:
projects $ cd my-appmy-app $ slush react-ts
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 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. We recommend using version 0.1.10
or higher
$ npm view react-native-cli version0.1.8
Install react-native-cli
$ npm uninstall -g react-native-cli
$ npm install -g react-native-cli
Sub generators
Currently we have TypeScript sub-generators for:
redux
: configure app for using Reduxredux-model
: create full Redux domain model setupwebpack
: configure webpackweb
: create react web app
Usage example: $ slush react-ts:redux
Feel free to suggest and contribute with more/better generators!
Redux
Configures the src
folder for Redux as follows:
/flux /actions /__spec__ /constants /models /reducers /__spec__ rootReducer.ts /native /components /containers /web /components /containers
The __spec__
folders contain specs (tests).
Redux model
- Asks for a model name (default:
todo
) - Asks for platforms to generate for (
web
,native
)
For a todo
model, it will create the following flux files:
/flux /actions /__spec__ todos-spec.ts todos.ts /constants todos.ts /models todos.ts /reducers /__spec__ todos-spec.ts todos.ts
For native
platform
/native /components TodoItem.tsx TodoList.tsx /containers TodoContainer.tsx
Similar layout for the web
platform.
Web
TodoList
will render a ul
DOM element
Native
TodoList
renders a ListView
of the domain model with a data source (using mock data).
On any platform, TodoList
will render each row using a TodoItem
component, passing the row data into props
using spread operator.
Contributing
See the CONTRIBUTING Guidelines
- Fork and clone the repo
- Use
npm link
to install locally - Run generator as decribed above
- Debug, fix and improve
Support
If you have any problem or suggestion please open an issue here.
Slush
To find out more about Slush, check out the documentation.
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.