Scaffold CLI - HackMD

# Partisia Blockchain Build Program | Scaffold CLI Thank you for your submission! Please fill in the sections below to ensure your project is reviewed accurately. > **Important:** To submit your project: > > 1. Fill out this template > 2. Submit your project through our [Monday Board](https://forms.monday.com/forms/a23209ca08d9c6b6cb9c08cb0a30466f?r=euc1) > 3. Create a GitHub Issue in this repository with your progress updates --- ## 0. Legal Requirements By submitting to this program, I confirm that: - [x] I am over 18 years old or the age of majority in my jurisdiction of residence, or I am a business entity - [x] I am not a resident of, citizen of, or located in: - [ ] United States - [ ] Any geographic area subject to UN sanctions - [ ] Any geographic area subject to US sanctions - [ ] Any geographic area subject to EU sanctions - [ ] Any geographic area subject to Swiss sanctions - [ ] Any geographic area subject to any other sovereign country sanctions or embargoes --- ## 1. Project Information - **Project Title:** Partizee - **Project Tier:** - [ ] Beginner (Easy) – Reward up to $2,000 - [ ] Intermediate (Medium) – Reward $2,000–$4,000 - [x] Advanced (Hard) – Reward $4,000+ _(Select the tier that best fits your project)_ - **Reward:** $4000 - **Estimated Timeline:** 2-4 weeks - **GitHub Repository Link:** tba - **Contact Info:** mrdeadce11 on discord - **Team Members:** mrdeadce11 georgeh0x --- ## 2. Project Brief We will be creating a a scaffolding CLI tool written in rust to provide a quick way to scaffold/compile and deploy new smart contracts and dapps. It will be able to create simple dapp repos with boilerplate code, compile / deploy contracts. The scope needs to stay fairly limited given budget and time concerns, however we intend to leave it open ended so functionality can be updated and expanded later. This will be a tool for developers interested in a quick way to onboard to the partisia ecosystem. --- ## 3. Technical Description ### 3.1 Detailed Overview We are proposing the development of a Rust-based CLI tool for scaffolding, compiling, and deploying decentralized applications (DApps) on the Partisia Blockchain. The tool will streamline fullstack DApp development by generating a modular project structure that includes a configurable Next.js Dapp and Rust-based smart contracts. At the core of the compilation and deployment workflow, the CLI will leverage the official `partisia-contract` crate to interface directly with the Partisia smart contract compiler. By integrating the partisia-contract crate directly, smart contracts will be compiled into Partisia-compatible bytecode and deployed using partisia's exiting toolkits. The CLI will use `clap` for structured command parsing and `inquire` to provide an interactive, menu-driven scaffolding experience. Source code and configuration files—such as Cargo.toml, package.json, tsconfig.json, and contract boilerplate—will be generated using `tera` templates, tailored according to user selections. ### 3.2 Technical Approach - **Core Functionality:** Scaffolding, compiling and deployment of dapps - **Security Considerations:** Possible future additions could include a key managment system to avoid saving private keys in plain text. ### 3.3 Development Stack - **Core CLI:** Rust - **Crates:** partisia-contract, clap, cliclack, tera, cargo test - **Smart Contracts:** Rust (Partisia-compatible contract format) - **Dapp Scaffolding:** Next.js --- ## 4. Deliverables List all the deliverables included with your submission: - Source code - Comprehensive README with setup, usage, and testing instructions - Test coverage report --- ## 5. Project Timeline - **Start Date:** ASAP (May 15, 2025) - **Milestone 1:** - **Description:** Deliver core CLI infrastructure with functional scaffolding capability. This includes project repository setup, command structure implementation using clap, template system development with tera, and creation of Partisia-specific smart contract templates, basic React frontend scaffolding, and configuration file generation. The CLI will support basic project creation with an interactive interface using inquire for selecting project options. - **Target Date:** May 22, 2025 (1 week from start) - **Milestone 2:** - **Description:** Complete smart contract compilation and deployment functionality. Integrate with the partisia-contract crate to enable compilation of smart contracts, implement a streamlined deployment workflow for Partisia testnet, create basic key handling for deployment authorization, add deployment verification, and provide comprehensive documentation including quickstart guide and example usage scenarios. Deliver v0.1 release with end-to-end functionality (scaffold → compile → deploy). - **Target Date:** May 29, 2025 (2 weeks from start) - **Final Submission Date:** May 29, 2025 - **Buffer Time:** 2 days (May 30-31, 2025) *(This buffer allows for addressing any critical issues discovered during final testing or accommodating unexpected integration challenges with the Partisia ecosystem)* --- ## 6. Additional Information Include any additional details that you believe are important: - Known issues or limitations - Future improvements or enhancements planned - Any questions or clarifications you need from the review panel - Community engagement plan - Marketing or adoption strategy --- ## 7. Acknowledgment By submitting this project, I confirm that: - The work is my own or properly credited. - I agree to release the project under an approved open-source license. - I accept the evaluation rubric and community voting process. - I will provide weekly progress updates through GitHub Issues in this repository. - I understand that the project must be completed within the estimated timeline. - I will actively engage with the community and respond to feedback. - I understand that my project will be subject to community voting on [CrowdSnap](https://www.crowdsnap.ai/), which contributes 10% to the final evaluation score. --- _Thank you for your submission! We look forward to reviewing your project and will be in touch with feedback._