| 1 | # Makiswap
|
| 2 |
|
| 3 | [](https://github.com/Makiswap/makiswap-core/actions)
|
| 4 | [](https://www.npmjs.com/package/makiswap-core)
|
| 5 |
|
| 6 | In-depth documentation on Makiswap is available at [makiswap.org](https://makiswap.org/docs).
|
| 7 |
|
| 8 | The built contract artifacts can be browsed via [unpkg.com](https://unpkg.com/browse/makiswap-core@latest/).
|
| 9 |
|
| 10 | # Local Development
|
| 11 |
|
| 12 | The following assumes the use of `node@>=10`.
|
| 13 |
|
| 14 | ## Install Dependencies
|
| 15 |
|
| 16 | `yarn`
|
| 17 |
|
| 18 | ## Compile Contracts
|
| 19 |
|
| 20 | `yarn compile`
|
| 21 |
|
| 22 | ## Run Tests
|
| 23 |
|
| 24 | `yarn test`
|