| 1 | catreact-html
|
| 2 | =============
|
| 3 |
|
| 4 | **This module is the Catavolt React HTML Development Kit**
|
| 5 |
|
| 6 |
|
| 7 | # Using this module in your project
|
| 8 |
|
| 9 | * npm install --save catreact-html
|
| 10 |
|
| 11 |
|
| 12 | # Building the code (for contributors)
|
| 13 |
|
| 14 | * If using Typescript (recommended), [WebStorm](https://www.jetbrains.com/webstorm/) is recommended as an ide, as it has very good Typescript support
|
| 15 |
|
| 16 | * Install [Node.js](https://nodejs.org/en/) (5+ recommended) directly or use [nvm](https://github.com/creationix/nvm#installation) to easily manage installations
|
| 17 |
|
| 18 | * From this project's root directory (catreact-html), run **'npm install'**. This should install all required packages to the 'node_modules' directory in 'catreact-html', including the catavolt library dependencies.
|
| 19 |
|
| 20 |
|
| 21 | # Configuring WebStorm for Typescript:
|
| 22 |
|
| 23 | * Open the catreact project root folder in WebStorm
|
| 24 | * Go to WebStorm -> Preferences -> Languages and Frameworks -> Javascript
|
| 25 | * Set the Language Level to JSX Harmony
|
| 26 | * Go to WebStorm -> Preferences -> Languages and Frameworks -> TypeScript panel
|
| 27 | * Choose 'Enable TypeScript Compiler'
|
| 28 | * Make sure the path to the Node interpreter is correct
|
| 29 | * Choose 'Use tsconfig.json' radio option
|
| 30 | * Click 'Apply' and 'Ok'
|
| 31 | * Open the TypeScript Compiler panel at the bottom of WebStorm and Choose 'Compile All' from the buttons on the left
|
| 32 |
|
| 33 |
|
| 34 |
|
| 35 |
|
| 36 |
|
| 37 |
|
| 38 |
|
| 39 |
|