https://github.com/nomoixyz/vulcan-template

A template for projects writting smart contracts that use vulcan for testing
https://github.com/nomoixyz/vulcan-template

Last synced: 3 months ago
JSON representation

A template for projects writting smart contracts that use vulcan for testing

• Host: GitHub
• URL: https://github.com/nomoixyz/vulcan-template
• Owner: nomoixyz
• License: mit
• Created: 2023-03-02T21:13:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-29T20:37:06.000Z (about 1 year ago)
• Last Synced: 2024-04-08T20:14:18.155Z (7 months ago)
• Language: Solidity
• Size: 28.3 KB
• Stars: 30
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-foundry - Foundry Vulcan Template - This repository is a template for smart contract projects based on Foundry. It includes Vulcan to make your life easier when writing tests and scripts. (Templates & Libraries)

README

        
# Vulcan Template

This repository is a template for smart contract projects based on [Foundry](https://github.com/foundry-rs/foundry).

It includes [Vulcan](https://github.com/nomoixyz/vulcan) to make your life easier when writing tests and scripts. :heart:

## How to use the template

You can either click [here](https://github.com/nomoixyz/vulcan-template/generate) to let GitHub create the project for you, or you can do it manually by using the `forge init` CLI command:

```sh

forge init my-awesome-vulcan-project --template https://github.com/nomoixyz/vulcan-template

```

## Installing the `forge fmt` Git hook

If you want to check the format of your code before creating a commit, you can use the `install-fmt-hook.sh` script to create a `pre-commit` Git hook. This will replace the contents of the current `pre-commit` hook file, so be careful.

To install the hook, run:

```sh

chmod +x install-fmt-hook.sh

./install-fmt-hook.sh

```

Alternatively, you can use one of the following commands:

```sh

bash install-fmt-hook.sh

```

```sh

sh install-fmt-hook.sh

```