Skip to content

grinmorg/smart-deployer

 
 

Repository files navigation

Smart Deployer

Smart Deployer is a universal solution for organizing and managing paid smart contract deployments.

📚 Contracts documentation
🎓 Solidity Bootcamp

🧾 Every contract in this repository is fully documented using NatSpec — including deployment instructions, configuration details, and extensibility tips. Developed by Solidity University, following best practices and released under the MIT license, allows developers to:

  • Deploy your own DeployManager.sol
  • Create & connect utility contracts using template
  • Monetize the deployment of utility contracts
  • Enable\disable contracts, fees any time

Smart deployer diagram

💡 We are building it as part of the Solidity University Bootcamp program. Learn Solidity with us at Solidity University!


🚀 Getting Started

To start working with this repository, clone it and install all necessary dependencies.

git clone https://github.com/solidity-university/smart-deployer.git
cd smart-deployer
yarn install

✅ Make sure you have Foundry installed globally before continuing:


🛠 Build the Project

Compile the contracts using:

forge build

You can run 🧪 tests using:

forge test

📚 Generate Documentation

To generate contract documentation:

forge doc --build --out docs

The generated documentation will be available in the docs/ folder and automatically deploy to github pages. Make sure there is no .gitignore file inside docs/.


Feel free to contribute or open issues to improve the project 💡

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Solidity 99.4%
  • Shell 0.6%