Buidler-storage

This plugin relies on peer

Yarn

yarn add @symfoni/buidler-storage

NPM

npm install @nomiclabs/buidler @symfoni/buidler-typechain buidler-deploy

Installation

We recommend developing Buidler plugins using yarn. To start working on your project, just run

yarn install

Plugin development

Make sure to read our Plugin Development Guide to learn how to build a plugin, and our best practices to create high-quality plugins.

Testing

Running npm run test will run every test located in the test/ folder. They use mocha and chai, but you can customize them.

We recommend creating unit tests for your own modules, and integration tests for the interaction of the plugin with Buidler and its dependencies.

Linting and autoformat

All all of Buidler projects use prettier and tslint.

You can check if your code style is correct by running npm run lint, and fix it with npm run lint:fix.

Building the project

Just run npm run buidl ️👷‍

README file

This README describes this boilerplate project, but won't be very useful to your plugin users.

Take a look at README-TEMPLATE.md for an example of what a Buidler plugin's README should look like.