1/5
## Cleaning Up the Project We've covered a lot of ground in this project. We learned how to write our first Solidity contract, how to deploy it to a test network, and how to interact with it using Forge. Before we move on to more complex projects, let's take a moment to clean things up and make sure our project is well-organized. ### Formatting One important aspect of any project is consistency in formatting. We've been using VS Code's auto-formatter to help us with this, but it's important to make sure that anyone else working on the project is following the same formatting rules. Forge has a built-in format command that we can use to ensure consistent formatting across the project. We can run this command in our terminal with: ```bash forge fmt ``` This command will automatically format all our Solidity files according to Forge's default style. ### README.md Another important file to include in any project is a `README.md` file. This file serves as a guide for anyone who wants to learn about your project, how to use it, or how to contribute to it. The `README.md` file is written in Markdown, which is a lightweight markup language that's easy to read and write. Here's an example of what you might include in your `README.md` file: ````markdown # SimpleStorage This is a simple Solidity contract that stores a single uint256 value. ## Getting Started 1. Clone this repository. 2. Install Forge using the instructions found at [https://github.com/foundry-rs/foundry](https://github.com/foundry-rs/foundry). 3. Run the following command to compile the contract: ```bash forge build ``` 4. Run the following command to deploy the contract to a test network: ```bash forge create ``` 5. Interact with the contract using Forge's interactive console. ```bash forge console ``` ## Contributing We welcome contributions to this project. If you're interested in contributing, please open an issue or submit a pull request. ``` We can preview our `README.md` file in VS Code by going to the `View` menu and selecting `Open Preview to the Side`. This will open a new window showing what the `README.md` file will look like when it's rendered on GitHub. ### Using AI for Markdown Formatting If you find that formatting Markdown is a bit tedious, you can use an AI tool like ChatGPT to help you out. Just copy and paste the text you want to format into ChatGPT and ask it to format it in Markdown. It will do a pretty good job of converting your plain text into Markdown, and you can then review and edit it as needed. ````
Cleaning up the project!
Previous lesson
Previous
Next lesson
Next
Give us feedback
Course Overview
About the course
Foundryup, Foundry Forge, and Anvil
Blockchain Oracles
How to create local Blockchain testnets
How to verify a smart contract
How to write and run smart contract tests
Security researcher
$49,999 - $120,000 (avg. salary)
Smart Contract Engineer
$100,000 - $150,000 (avg. salary)
Web3 developer
$60,000 - $150,000 (avg. salary)
Web3 Developer Relations
$85,000 - $125,000 (avg. salary)
Smart Contract Auditor
$100,000 - $200,000 (avg. salary)
Guest lecturers:
Last updated on January 14, 2025
Solidity Developer
Foundry FundamentalsDuration: 2h 55min
Duration: 2h 56min
Duration: 26min
Duration: 5h 22min
Course Overview
About the course
Foundryup, Foundry Forge, and Anvil
Blockchain Oracles
How to create local Blockchain testnets
How to verify a smart contract
How to write and run smart contract tests
Security researcher
$49,999 - $120,000 (avg. salary)
Smart Contract Engineer
$100,000 - $150,000 (avg. salary)
Web3 developer
$60,000 - $150,000 (avg. salary)
Web3 Developer Relations
$85,000 - $125,000 (avg. salary)
Smart Contract Auditor
$100,000 - $200,000 (avg. salary)
Guest lecturers:
Last updated on January 14, 2025
Testimonials
Read what our students have to say about this course.
Chainlink
Chainlink
Gustavo Gonzalez
Solutions Engineer at OpenZeppelin
Francesco Andreoli
Lead Devrel at Metamask
Albert Hu
DeForm Founding Engineer
Radek
Senior Developer Advocate at Ceramic
Boidushya
WalletConnect
Idris
Developer Relations Engineer at Axelar