Skip to content

Commit 1e5d7b8

Browse files
committed
docs(readme): add quickstart + web script
1 parent 07e32d3 commit 1e5d7b8

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

README.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,28 @@ Compose the application from available screens, add backend integration and you
66
The themes can be changed in the runtime, without any need of reloading the application.
77

88
Download a live Demo published on both [App Store][link:app-store] and [Google Play][link:google-play]
9-
or simply run it yourself by cloning a GitHub repo.
9+
or simply run it yourself by cloning a GitHub repo (see the **[DEV_DOCS](./DEV_DOCS.md)** for more information)
10+
11+
12+
-----
13+
14+
<details>
15+
<summary>Quick-start Instructions</summary>
16+
17+
## Quickstart
18+
19+
Follow the instructions below to fetch and configure the KittenTricks project and start a web interface from which you can launch iOS + Android device simulators or a browser-based experience
20+
21+
```sh
22+
git clone https://github.com/akveo/kittenTricks
23+
cd kittenTricks
24+
yarn # npm install
25+
yarn run web # npm run start
26+
```
27+
28+
</details>
29+
30+
------
1031

1132
![Kitten Material](https://camo.githubusercontent.com/f0487d92194f3c685213539c53e9784113cd8a4b/68747470733a2f2f692e696d6775722e636f6d2f58384f344748622e706e67)
1233

package.json

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
"ios": "react-native run-ios",
2323
"start": "npm run env -- prod && react-native start",
2424
"start:dev": "npm run env -- dev && react-native start --reset-cache",
25+
"web": "npm run env -- dev && expo start --web",
2526
"env": "node ./env/set-env.js",
2627
"build": "tsc -p ./tsconfig.json",
2728
"build:web": "expo build:web",

0 commit comments

Comments
 (0)