Skip to content

Commit

Permalink
feat/backend(2.0.1-rc) (#26)
Browse files Browse the repository at this point in the history
## Version [2.0.1-rc] (29/12/2022)

### 🎸 FEAT

- Updated README and CHANGELOG
  • Loading branch information
thiagosaud committed Dec 29, 2022
1 parent 1e51920 commit 570a16a
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 11 deletions.
6 changes: 6 additions & 0 deletions backend/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ Use the pattern below:

- Refactored Contracts and Tests

## Version [2.0.1-rc] (29/12/2022)

### :guitar: FEAT

- Updated README and CHANGELOG

---

**THANK YOU FOR YOUR CONTRIBUTION TO THE PROJECT. 💖
Expand Down
78 changes: 68 additions & 10 deletions backend/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,71 @@
# Sample Hardhat Project
## :crown: Backend Technologies

This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, and a script that deploys that contract.
| NAME | URL |
| ------------ | ------------------------------------------------------------------ |
| SOLIDITY | [LINK](https://docs.soliditylang.org/en/latest/) |
| SOLHINT | [LINK](https://github.com/protofire/solhint/blob/master/README.md) |
| HARDHAT | [LINK](https://hardhat.org/) |
| WAFFLE | [LINK](https://getwaffle.io/) |
| MOCHA | [LINK](https://mochajs.org/) |
| JEST | [LINK](https://jestjs.io/pt-BR/) |
| CHAI | [LINK](https://www.chaijs.com/) |
| ESLINT | [LINK](https://eslint.org/) |
| EDITORCONFIG | [LINK](hhttps://editorconfig.org/) |
| PRETTIER | [LINK](https://prettier.io/) |
| ETHERS | [LINK](https://docs.ethers.org/v5/) |

Try running some of the following tasks:
## :wrench: Backend Techniques

```shell
npx hardhat help
npx hardhat test
REPORT_GAS=true npx hardhat test
npx hardhat node
npx hardhat run scripts/deploy.ts
```
| NAME | TECHNOLOGIES |
| ------------------------------------- | ------------------------------ |
| ETHEREUM DEV FOR PROFESSIONALS | HARDHAT, ETHERS |
| CODE SYNTAX ANALISYS | ESLINT, SOLHINT |
| CODE STYLE-GUIDE | AIRBNB, PRETTIER, EDITORCONFIG |
| BRANCH CONTROL AND STANDARDIZATION | BRANCHNAMELINT |
| COMMIT CONTROL AND STANDARDIZATION | COMMITLINT |
| GIT HOOKS CONTROL AND STANDARDIZATION | HUSKY |
| UNIT TEST | JEST, CHAI, MOCHA AND WAFFLE |

## :electric_plug: How it works

To install the dependencies, run the following command:

`yarn`

To start the project, run the following command:

`yarn start`

To test the project, run the following command:

`yarn jest`

To test the parsing and style-guide of the code, you can run the following commands separately:

`yarn lint:check`

`yarn lint-contracts:check`

`yarn prettier:check`

To compile the contract:

`yarn compile`

To deploy in homologation on the GOERLI network:

`yarn deploy:testnet`

To sign the contract on the ethereum blockchain:

`yarn verify:testnet`

## :heartpulse: Sponsor

Made with ♥ and with the intention of learning and passing on knowledge.

So that I can work full-time and open to the community, thus bringing more relevance and technological solutions. It would mean a lot to me and the whole community if you help me reach this goal.

[![MY SPONSORS](https://img.shields.io/static/v1?label=SPONSOR&message=CLICK&style=for-the-badge&logo=GitHubSponsors&color=EA4AAA)](https://github.com/sponsors/thiagosaud)

---
2 changes: 1 addition & 1 deletion backend/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "superior-electoral-court-contract",
"version": "2.0.0-rc",
"version": "2.0.1-rc",
"license": "MIT",
"description": "This project is the smart contract for Superior Electoral Court (TSE).",
"author": {
Expand Down

1 comment on commit 570a16a

@vercel
Copy link

@vercel vercel bot commented on 570a16a Dec 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.