[](https://github.com/carboclan/dapp.honeylemon.market/blob/master/LICENSE) [](https://github.com/carboclan/dapp.honeylemon.market/commits/master) [](https://app.honeylemon.market/) [](https://t.me/joinchat/I9o0JBU3JKkxb-yRSkIFvA) 
## Documentation 📖
Our docs site is [here](https://docs.honeylemon.market). Here you will find details on the protocol design, financial contracts and main net deployment addresses. You can also find it directly from this repo in the [documentation folder](https://github.com/carboclan/dapp.honeylemon.market/tree/72ee3b42bd4888ec1d0bace7112c562b16f71719/docs/README.md).
## Mono Repo Structure 🏗
The repository is broken up into 4 main packages, managed using yarn workspaces. You can find these in the `packages` directory. These packages are as follows:
#### 1\) **`packages/contracts`**
Smart contracts, deployment scripts and integration tests for the Honeylemon protocol. The contract bring together MarketProtcol 0x MinterBridge and custom HoneyLemon contracts to create the protocols financial contracts.
#### 2\) **`packages/honeylemon.js`**
Javascript library used to connect to the Honeylemon protocol. This library is used by the front end to wrap complex interactions like submitting orders or batch token redemption.
#### 3\) **`packages/subgraph`**
The Graph subgraph used to index contract events for front end retrieval. Used directly by `honeylemon.js`.
#### 4\) **`packages/webapp`**
React Typescript, dapp front end. Can be found online [here](https://app.honeylemon.market).
## Setting up the Honeylemon protocol 👩💻
### Development Environment 👷♂️
You'll need the latest LTS release of nodejs and npm installed. You'll also need Docker installed for your operating system. Assuming that's done, run:
```text
yarn
```
If you are having issues running the sub graph locally (or in a Docker container) then navigate to the subgraph directory and run an additional install there. To do this run
```
cd packages/subgraph
npm install
```
Once this is done you can start the local development env by running a make command. This will clean all data and start/restart docker containers. Some unit tests are coupled and require you to run this between executions as well such as running If running `order-test.js` script.
```text
make local-reset
```
After running this you will have a local 0x API, a Ganache instance and a Subgraph running on your local machine in docker containers. You can run `docker ps -a` to see al l the containers running.
### Running Tests🧪
Next, you can run the tests. There are three main tests kinds of tests: 1\) Smart contract tests, 2\) Honeylemon.js service tests that validate the service data retrieval and on-chain interactions including the Graph protocol and 3\) integration tests that show full lifesycle interconnection between the Marketprotocol, 0x order book, DSProxy contracts and the custom honey lemon smart contracts.
```text
yarn run test:contracts #Smart contract tests. Used throughout the stack.
yarn run test:integration #Note that this will start the docker environment to execute test logic.
yarn run test:service #Honey lemon.js service tests. Used in front end.
```
## Building packages 🛠
You can build each of the packages within the repo by executing the following.
```text
yarn build:contracts
yarn build:honeylemonjs
yarn build:subgraph
yarn build:webapp
release:webapp
```
### React Front End 🖥
Running the front end can be done by executing:
```text
yarn start:webapp
```
### Deploying Smart Contracts 🧨
If you want to deploy smart contracts to a test network you can run:
```text
truffle migrate --network kovan
```
### Updating MarketContractProxy Address 🚀
When MarketContractProxy address changes it needs to be updated in the following places:
- docker/docker-compose-local.yml \(look for `HONEYLEMON_MARKET_CONTARCT_PROXY_ADDRESS`\)
- subgraph/subgraph.yml \(in the MarketContractProxy source `address` field\)
### Running The Linter 🧽
To run the formatter, run:
```text
yarn lint
```
### Coverage 🔎
We use the [solidity-coverage](https://github.com/sc-forks/solidity-coverage) package to generate our coverage reports. These can be generated manually by developers. There are no regression tests or published reports. CircleCI does generate a coverage report automatically, but if you'd like to generate it locally, run:
```text
./ci/coverage.sh core
```
The full report can be viewed by opening the `core/coverage/index.html` file in a browser. The full report can be viewed by opening the `core/coverage/index.html` file in a browser. You can also find an online version of our covarge report on [coveralls](https://coveralls.io/github/dapp.honeylemon.market).