Skip to content

Commit

Permalink
Added additional native documentation for capacitor
Browse files Browse the repository at this point in the history
  • Loading branch information
craigtweedy committed Mar 7, 2021
1 parent e51bda0 commit 4718008
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ ChopChop is our beautifully designed, elegantly developed demo store and starter
* [Ionic Framework](https://ionicframework.com/)
* [Commerce.js](https://commercejs.com)
* [Stripe](https://stripe.com)
* [Capacitor](https://capacitorjs.com)

### Manual installation

Expand All @@ -38,14 +39,34 @@ Once the server is running, it'll open up in your browser automatically, start e

### Testing on native

To get the project running natively, run one of the following commands.
This project can be built for either iOS or Android using Capacitor. Capacitor makes it easy to build web applications that can be ran natively.

`ionic capacitor run ion -l --external`
Ensure capacitor is included in the project by running:
```
npx cap init [appName] [appId]
```

`ionic capacitor run android -l --external`
Also, ensure the project has been built once by running:
```
ionic build
```

Next, add a desired platform to the project:
```
npx cap add ios
npx cap add android
```

From here, we can run the project natively using one of the following commands:
```
ionic capacitor run ion -l --external
ionic capacitor run android -l --external
```

Ionic will build the project in your platform of choice, and then you can run it in a simulator or on device from that point.

> If you find that your project has not updated correctly in the native build, run `npx cap copy` to ensure the native outputs have the latest built code.
## License

This project is licensed under [BSD-3-Clause](LICENSE.md).

0 comments on commit 4718008

Please sign in to comment.