Skip to content

Commit

Permalink
Added license and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
craigtweedy committed Mar 4, 2021
1 parent edfa4f2 commit 4e0cbfd
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
9 changes: 9 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Copyright (c) 2021 Chec Platform LLC, All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3) Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<p align="center">
<img src="https://raw.githubusercontent.com/chec/commercejs-examples/master/assets/logo.svg" width="380" height="100" />
</p>
<p align="center">
A CommerceJS, Ionic, React & Stripe powered, open source native enabled storefront, cart and checkout experience.
</p>
<p align="center">
<a href="/chec/[repourl]/blob/main/LICENSE.md">
<img src="https://img.shields.io/npm/l/@chec/commerce.js.svg" alt="License" />
</a>
<br>
<a href="https://commercejs.com">commercejs.com</a> | <a href="https://twitter.com/commercejs">@commercejs</a> | <a href="http:https://slack.commercejs.com">Slack</a>
<br />
<br />
<img src="[demo image]" width="600" />
</p>

## Introduction

ChopChop is our beautifully designed, elegantly developed demo store and starter kit that sells fine tools for thoughtful cooks. We’ve created a premium brand with a commerce experience to match, ready for native platforms. Read more about this resource on the [Commerce.js blog]([article-URL]).

## 🥞 ChopChop Native Stack

* [Ionic Framework](https://ionicframework.com/)
* [Commerce.js](https://commercejs.com)
* [Stripe](https://stripe.com)

### Manual installation

Clone the project, then get started by installing the dependencies, and starting the dev server.

```
yarn install
yarn start
```

Once the server is running, it'll open up in your browser automatically, start editing the code, and enjoy!

### Testing on native

To get the project running natively, run 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.

## License

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

0 comments on commit 4e0cbfd

Please sign in to comment.