UNPKG

catreact

Version:

Catavolt Core React Components

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