Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(readme): add quickstart + web script #322

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(readme): add quickstart + web script #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,28 @@ Compose the application from available screens, add backend integration and you
The themes can be changed in the runtime, without any need of reloading the application.

Download a live Demo published on both [App Store][link:app-store] and [Google Play][link:google-play]
or simply run it yourself by cloning a GitHub repo.
or simply run it yourself by cloning a GitHub repo (see the **[DEV_DOCS](./DEV_DOCS.md)** for more information)


-----

<details>
<summary>Quick-start Instructions</summary>

## Quickstart

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

```sh
git clone https://github.com/akveo/kittenTricks
cd kittenTricks
yarn # npm install
yarn run web # npm run start
```

</details>

------

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

Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"ios": "react-native run-ios",
"start": "npm run env -- prod && react-native start",
"start:dev": "npm run env -- dev && react-native start --reset-cache",
"web": "npm run env -- dev && expo start --web",
"env": "node ./env/set-env.js",
"build": "tsc -p ./tsconfig.json",
"build:web": "expo build:web",
Expand Down