|
1 | 1 |  |
2 | 2 |
|
| 3 | +<<<<<<< HEAD |
3 | 4 |   |
| 5 | +======= |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +>>>>>>> develop |
4 | 10 |
|
5 | | -# Origin Platform |
| 11 | +# Origin Protocol |
6 | 12 |
|
7 | 13 | Origin Protocol is a library of javascript code and Ethereum smart contracts which allow anyone to create decentralized marketplaces, including for fractional usage. |
8 | 14 |
|
@@ -77,22 +83,28 @@ And buyers to: |
77 | 83 |
|
78 | 84 | ### Local |
79 | 85 |
|
80 | | -1. Clone |
81 | | -``` |
82 | | -git clone https://github.com/OriginProtocol/platform origin-platform && cd origin-platform |
83 | | -``` |
84 | | - |
85 | | -2. Setup (shortcut for `npm install && npm link`). Linking makes this available as a local npm package for local dapp development. |
86 | | - ``` |
87 | | - npm run setup |
88 | | - ``` |
89 | | - |
90 | | -3. Start the localblockchain and create the build. Code changes will trigger a live rebuild. |
91 | | - ``` |
92 | | - npm start |
93 | | - ``` |
94 | | - |
95 | | - 4. To develop against a working dapp and UI, see [the instructions in our demo dapp](https://github.com/OriginProtocol/demo-dapp#developing-with-a-local-chain). |
| 86 | +1. `git clone` your fork. Note that the latest commits will be on the `develop` |
| 87 | + branch. So switch to that branch if you want to submit a PR or check out |
| 88 | + recently merged code. |
| 89 | + |
| 90 | +1. Install:dev (shortcut for `npm install && npm link`). Linking makes this available as a local npm package for local dapp development. |
| 91 | + ``` |
| 92 | + npm run install:dev |
| 93 | + ``` |
| 94 | +
|
| 95 | +1. Start the localblockchain and create the build. Code changes will trigger a live rebuild. |
| 96 | + ``` |
| 97 | + npm start |
| 98 | + ``` |
| 99 | + |
| 100 | + In order to conduct test transactions, you can create a new wallet using the following seed phrase (Mnemonic): |
| 101 | + |
| 102 | + _**Be careful to back up the seed phrases and private keys for any existing wallets before creating a new one.**_ |
| 103 | + ``` |
| 104 | + candy maple cake sugar pudding cream honey rich smooth crumble sweet treat |
| 105 | + ``` |
| 106 | +
|
| 107 | +1. To develop against a working dapp and UI, see [the instructions in our demo dapp](https://github.com/OriginProtocol/demo-dapp#developing-with-a-local-chain). |
96 | 108 |
|
97 | 109 | ## Import |
98 | 110 |
|
@@ -120,6 +132,7 @@ git clone https://github.com/OriginProtocol/platform origin-platform && cd origi |
120 | 132 | - `ipfsApiPort` |
121 | 133 | - `ipfsGatewayPort` |
122 | 134 | - `ipfsGatewayProtocol` |
| 135 | + - `attestationServerUrl` |
123 | 136 |
|
124 | 137 | ## IPFS |
125 | 138 |
|
@@ -160,13 +173,31 @@ git clone https://github.com/OriginProtocol/platform origin-platform && cd origi |
160 | 173 |
|
161 | 174 | ## Tests |
162 | 175 |
|
163 | | - Browser tests are automatically served at `http://localhost:8081` when you run `npm start`. |
| 176 | + ### Command Line (All Tests) |
| 177 | +
|
| 178 | +Our full test suite can be run with: |
| 179 | +
|
| 180 | + ``` |
| 181 | + npm run test |
| 182 | + ``` |
| 183 | +
|
| 184 | + Note: you should *not* have the server running at this time, as these tests start their own local blockchain instance. |
| 185 | +
|
| 186 | + ### Command Line (Only Solidity Tests) |
| 187 | +
|
| 188 | +Our Solidity tests (which use [Truffle](http://truffleframework.com/docs/getting_started/javascript-tests)) are located at `contracts/test`. |
| 189 | +
|
| 190 | + ``` |
| 191 | + npm run test:contracts |
| 192 | + ``` |
| 193 | +
|
| 194 | + Note: you should *not* have the server running at this time, as these tests start their own local blockchain instance. |
164 | 195 |
|
165 | | - Tests are automatically rerun when source or test code is changed. |
| 196 | + ### Browser Tests |
166 | 197 |
|
167 | | - Run a subset of tests using the `grep` query string parameter, for example: http://localhost:8081/?grep=IpfsService |
| 198 | + A subset of our tests can be run from the browser. These tests are automatically served at `http://localhost:8081` when you run `npm start`. These tests are automatically rerun when source or test code is changed. |
168 | 199 |
|
169 | | - We also have contract unit tests that are not run in the browser. These can be run with `npm run test:contracts` (you should *not* have the server running at this time, as these tests start their own local blockchain instance). |
| 200 | + Run a subset of these tests using the `grep` query string parameter, for example: http://localhost:8081/?grep=IpfsService |
170 | 201 |
|
171 | 202 | ## Documentation |
172 | 203 |
|
|
0 commit comments