Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
antorenge committed May 21, 2018
1 parent f5226cc commit a585990
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
# provJewellery

Provenance DApp for Handcrafted Jewellery
Decentralized Application (dApp) that helps users to determine provenance for handcrafted jewellery.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

* Node.js
* Angular CLI
* Truffle framework
* Ganache CLI
* MetaMask plugin

### Installing

To install packages

```{shell}
npm install
```

Initialize TestRPC server with 100 Ether tokens

```{shell}
testrpc --account="0x<PRIVATE_KEY>,100000000000000000000"
```

Once this is done, you can run the application

```{shell}
ng serve
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

0 comments on commit a585990

Please sign in to comment.