v0-contracts
v1.0.0
Published
[![CI](https://github.com/ExomoonProtocol/v0-contracts/actions/workflows/ci.yml/badge.svg)](https://github.com/ExomoonProtocol/v0-contracts/actions/workflows/ci.yml)
Downloads
2
Readme
Exomoon - v0 Smart Contracts
This repository contains the Exomoon v0
Smart contracts.
Installation
To install the package, run the following command:
yarn install
Scripts
The package provides the following scripts:
yarn compile
: This script compiles the source code.yarn test
: This script runs all unit tests.yarn lint
: This script performs static analysis of the code to detect issues.yarn generate-docs
: This script generates code documentation.
Build
To build the package, run the following command:
yarn compile
This command compiles the source code and generates output files in the dist
directory.
Testing
To run the unit tests, run the following command:
yarn test
This command runs all unit tests and prints a report of the results.
Linting
To perform static analysis of the code, run the following command:
yarn lint
This command analyzes the source code and detects any issues.
Documentation Generation
To generate code documentation, run the following command:
yarn docs
This command generates code documentation and saves it in the docs
directory.