open-index/open-npm huggingface dataset:
npm package: @magicdust/draconis
Description: The best ally to your Web3 contributor journey. Become a DeWorker now.
Author: Abdelhamid Bakhta
Latest version: 0.0.1

<div align="center">
  <h1 align="center">Draconis</h1>
  <p align="center">
    <a href="https://magicdust.gg">
        <img src="https://img.shields.io/badge/Website-https%3A%2F%2Fmagicdust.gg-blueviolet">
    </a>  
    <a href="https://etherscan.io/address/magicdust.eth">
        <img src="https://img.shields.io/static/v1?label=Ethereum&message=magicdust.eth&color=ff69b4">
    </a>
    <a href="https://github.com/MagicDustGG/draconis/graphs/contributors">
      <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/MagicDustGG/draconis">
    </a>
    <a href="http://makeapullrequest.com">
      <img alt="pull requests welcome badge" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat">
    </a>
    <a href="https://twitter.com/intent/follow?screen_name=Magicdust_gg">
        <img src="https://img.shields.io/twitter/follow/Magicdust_gg?style=social&logo=twitter"
            alt="follow on Twitter"></a>
    <a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"
            alt="License"></a>
    <a href=""><img src="https://img.shields.io/badge/semver-0.0.1-blue"
            alt="License"></a>            
  </p>
  
  <h3 align="center">Ultimate decentralized bounty management platform.</h3>
</div>

## Usage

### Pre Requisites

Proceed with installing dependencies:

```sh
yarn install
```

### Compile

Compile the smart contracts with Hardhat:

```sh
$ yarn compile
```

### Generate ABIs

Generate the smart contracts ABI files with Hardhat:

```sh
$ yarn abi
```

### TypeChain

Compile the smart contracts and generate TypeChain artifacts:

```sh
$ yarn typechain
```

### Format code

Format the code:

```sh
$ yarn prettier
```

### Lint Solidity

Lint the Solidity code:

```sh
$ yarn lint:sol
```

### Lint TypeScript

Lint the TypeScript code:

```sh
$ yarn lint:ts
```

### Test

Run the Mocha tests:

```sh
$ yarn test
```

### Coverage

Generate the code coverage report:

```sh
$ yarn coverage
```

### Report Gas

See the gas usage per unit test and average gas per method call:

```sh
$ REPORT_GAS=true yarn test
```

### Clean

Delete the smart contract artifacts, the coverage reports and the Hardhat cache:

```sh
$ yarn clean
```

### Deploy

Deploy the contracts to Hardhat Network:

```sh
$ yarn deploy
```

## Syntax Highlighting

If you use VSCode, you can enjoy syntax highlighting for your Solidity code via the
[vscode-solidity](https://github.com/juanfranblanco/vscode-solidity) extension. The recommended approach to set the
compiler version is to add the following fields to your VSCode user settings:

```json
{
  "solidity.compileUsingRemoteVersion": "v0.8.4+commit.c7e474f2",
  "solidity.defaultCompiler": "remote"
}
```

Where of course `v0.8.4+commit.c7e474f2` can be replaced with any other version.