walrus-starter-kit
v0.1.0
Published
Interactive CLI for scaffolding Walrus applications on the Sui blockchain.
Readme
Walrus Starter Kit
Interactive CLI for scaffolding Walrus applications on the Sui blockchain.
Overview
This monorepo contains the create-walrus-app CLI tool that helps developers quickly scaffold Walrus applications with best practices and modern tooling.
Project Structure
walrus-starter-kit/
├── packages/
│ └── cli/ # The scaffolder CLI tool
├── templates/ # Static template assets (excluded from workspace)
├── examples/ # Generated test outputs
└── docs/ # Project documentationPrerequisites
- Node.js >= 18.0.0
- pnpm >= 9.0.0
Getting Started
Installation
pnpm installBuild
pnpm buildDevelopment
cd packages/cli
pnpm devScripts
pnpm build- Build all packagespnpm test- Run tests across all packagespnpm lint- Lint all TypeScript filespnpm format- Format code with Prettierpnpm release- Test release process locally (dry-run)
Contributing
We use Conventional Commits for automated versioning and releases. See CONTRIBUTING.md for details.
Releasing
Releases are automated using semantic-release. See RELEASE_GUIDE.md for the complete release process.
Packages
create-walrus-app
Interactive CLI for scaffolding Walrus applications. See packages/cli for details.
License
MIT
