|
@@ -25,10 +25,12 @@ create a new repository with this repo as the initial state.
|
|
|
|
|
|
## Features
|
|
## Features
|
|
|
|
|
|
-This template builds upon the frameworks and libraries mentioned above, so for details about their specific features, please consult their respective documentations.
|
|
|
|
|
|
+This template builds upon the frameworks and libraries mentioned above, so for details about their specific features,
|
|
|
|
+please consult their respective documentations.
|
|
|
|
|
|
-For example, for Hardhat, you can refer to the [Hardhat Tutorial](https://hardhat.org/tutorial) and the [Hardhat
|
|
|
|
-Docs](https://hardhat.org/docs). You might be in particular interested in reading the [Testing Contracts](https://hardhat.org/tutorial/testing-contracts) section.
|
|
|
|
|
|
+For example, for Hardhat, you can refer to the [Hardhat Tutorial](https://hardhat.org/tutorial) and the
|
|
|
|
+[Hardhat Docs](https://hardhat.org/docs). You might be in particular interested in reading the
|
|
|
|
+[Testing Contracts](https://hardhat.org/tutorial/testing-contracts) section.
|
|
|
|
|
|
### Sensible Defaults
|
|
### Sensible Defaults
|
|
|
|
|
|
@@ -60,20 +62,23 @@ You can edit the CI script in [.github/workflows/ci.yml](./.github/workflows/ci.
|
|
|
|
|
|
### Conventional Commits
|
|
### Conventional Commits
|
|
|
|
|
|
-This template enforces the [Conventional Commits](https://www.conventionalcommits.org/) standard for git commit messages.
|
|
|
|
-This is a lightweight convention that creates an explicit commit history, which makes it easier to write automated
|
|
|
|
-tools on top of.
|
|
|
|
|
|
+This template enforces the [Conventional Commits](https://www.conventionalcommits.org/) standard for git commit
|
|
|
|
+messages. This is a lightweight convention that creates an explicit commit history, which makes it easier to write
|
|
|
|
+automated tools on top of.
|
|
|
|
|
|
### Git Hooks
|
|
### Git Hooks
|
|
|
|
|
|
-This template uses [Husky](https://github.com/typicode/husky) to run automated checks on commit messages, and [Lint Staged](https://github.com/okonet/lint-staged) to automatically format the code with Prettier when making a git commit.
|
|
|
|
|
|
+This template uses [Husky](https://github.com/typicode/husky) to run automated checks on commit messages, and
|
|
|
|
+[Lint Staged](https://github.com/okonet/lint-staged) to automatically format the code with Prettier when making a git
|
|
|
|
+commit.
|
|
|
|
|
|
## Usage
|
|
## Usage
|
|
|
|
|
|
### Pre Requisites
|
|
### Pre Requisites
|
|
|
|
|
|
-Before being able to run any command, you need to create a `.env` file and set a BIP-39 compatible mnemonic as an environment
|
|
|
|
-variable. You can follow the example in `.env.example`. If you don't already have a mnemonic, you can use this [website](https://iancoleman.io/bip39/) to generate one.
|
|
|
|
|
|
+Before being able to run any command, you need to create a `.env` file and set a BIP-39 compatible mnemonic as an
|
|
|
|
+environment variable. You can follow the example in `.env.example`. If you don't already have a mnemonic, you can use
|
|
|
|
+this [website](https://iancoleman.io/bip39/) to generate one.
|
|
|
|
|
|
Then, proceed with installing dependencies:
|
|
Then, proceed with installing dependencies:
|
|
|
|
|
|
@@ -157,13 +162,15 @@ $ yarn deploy --greeting "Bonjour, le monde!"
|
|
|
|
|
|
### Syntax Highlighting
|
|
### Syntax Highlighting
|
|
|
|
|
|
-If you use VSCode, you can get Solidity syntax highlighting with the [hardhat-solidity](https://marketplace.visualstudio.com/items?itemName=NomicFoundation.hardhat-solidity) extension.
|
|
|
|
|
|
+If you use VSCode, you can get Solidity syntax highlighting with the
|
|
|
|
+[hardhat-solidity](https://marketplace.visualstudio.com/items?itemName=NomicFoundation.hardhat-solidity) extension.
|
|
|
|
|
|
## Using GitPod
|
|
## Using GitPod
|
|
|
|
|
|
[GitPod](https://www.gitpod.io/) is an open-source developer platform for remote development.
|
|
[GitPod](https://www.gitpod.io/) is an open-source developer platform for remote development.
|
|
|
|
|
|
-To view the coverage report generated by `yarn coverage`, just click `Go Live` from the status bar to turn the server on/off.
|
|
|
|
|
|
+To view the coverage report generated by `yarn coverage`, just click `Go Live` from the status bar to turn the server
|
|
|
|
+on/off.
|
|
|
|
|
|
## License
|
|
## License
|
|
|
|
|