Skip to content
This repository was archived by the owner on Mar 11, 2021. It is now read-only.

Commit 69a0bb1

Browse files
authored
Update README.md
Add instructions to build the kitchen sink, as #13 points out was missing.
1 parent b1d2f69 commit 69a0bb1

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,35 @@ npm install --save framework7-react
1313

1414
Official docs are coming soon. For now, check out the [kitchen sink code](https://github.com/bencompton/framework7-react/tree/master/kitchen-sink) for an example of how to consume Framework7 React.
1515

16+
## Building + running the kitchen sink
17+
18+
Ensure that [gulp](https://www.npmjs.com/package/gulp) and [typings](https://www.npmjs.com/package/typings) are installed globally, then run the following:
19+
20+
To build the framework itself:
21+
22+
```javascript
23+
npm install
24+
typings install
25+
gulp
26+
```
27+
28+
To build the kitchen sink:
29+
30+
```javascript
31+
cd kitchen-sink
32+
npm install
33+
typings install
34+
gulp
35+
```
36+
37+
Here's a shortcut for building both after the above two steps have already been completed at least once:
38+
39+
```javascript
40+
npm run build
41+
```
42+
43+
Once the framework and kitchen sink are built, run the kitchen sink by launching kitchen-sink/index.html in a browser.
44+
1645
## Usage with Redux
1746

1847
Firstly, as the creator of [Redux points out](https://medium.com/@dan_abramov/you-might-not-need-redux-be46360cf367#.nfg6gm6yl), Redux is not a requirement for building apps with React. In turn, Redux is not a requirement for building apps with Framework7 React—it is designed to be perfectly usable either way. However, as your app grows beyond a certain level of complexity, it is definitely recommended that you consider Redux (or some other state management library like [MobX](https://github.com/mobxjs/mobx)). For more information about using Redux with Framework7 React, have a look at [Framework7 Redux](https://github.com/bencompton/framework7-redux).

0 commit comments

Comments
 (0)