UNPKG

2.31 kBMarkdownView Raw
1![](https://user-images.githubusercontent.com/232174/75543992-f1c39e00-5a1a-11ea-8fd4-8933638b5910.png)
2[![NPM Package](https://img.shields.io/npm/v/@nomiclabs/buidler.svg?style=flat-square)](https://www.npmjs.org/package/@nomiclabs/buidler)
3![Build Status](https://github.com/nomiclabs/buidler/workflows/CI/badge.svg)
4---------
5Buidler is a task runner for Ethereum smart contract developers. It facilitates performing frequent tasks, such as running tests, automatically checking code for mistakes or interacting with a smart contract. Check out the [plugin list](https://buidler.dev/plugins/) to use it with your existing tools.
6
7Developed by [Nomic Labs](https://nomiclabs.io/) and funded by an Ethereum Foundation grant.
8
9Join our [Buidler Support Discord server](https://invite.gg/BuidlerSupport) to stay up to date on new releases, plugins and tutorials.
10
11🚧 **For the most recently published code, look at the [`master`](https://github.com/nomiclabs/buidler/tree/master) branch** 🚧
12
13## Installation
14
15The recommended way of using Buidler is through a local installation in your project. This way your environment will be reproducible and you will avoid future version conflicts. To use it in this way you will need to prepend `npx` to run it (i.e. `npx buidler`). To install locally initialize your `npm` project using `npm init` and follow the instructions. Once ready run:
16
17 npm install --save-dev @nomiclabs/buidler
18
19## Documentation
20
21On [Buidler's website](https://buidler.dev) you will find:
22
23- [Guides to get started](https://buidler.dev/getting-started/)
24- [Buidler EVM](https://buidler.dev/buidler-evm/)
25- [Plugin list](https://buidler.dev/plugins/)
26- [API docs](https://buidler.dev/api/)
27
28
29## Contributing
30
31Contributions are always welcome! Feel free to open any issue or send a pull request.
32
33Go to [CONTRIBUTING.md](./CONTRIBUTING.md) to learn about how to set up Buidler's development environment.
34
35## Feedback, help and news
36
37[Buidler Support Discord server](https://discord.gg/ADQjyW8): for questions and feedback.
38
39[Follow Nomic Labs on Twitter.](https://twitter.com/nomiclabs)
40
41
42## Happy buidling!
43
44👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️