Overview
The Web3 starter kit provides developers with an efficient and straightforward way to initiate a Web3 project, combining a web client, API, and smart contracts into a single package. Its minimalist design aligns well with the core principles of Web3, allowing for easy customization to suit individual needs. The kit also includes various branches that unlock advanced functionalities right from the start, such as support for autonomous worlds through Mud and token-bound accounts.
As a monorepo, the structure of the codebase is clean and organized, making it easy to navigate and implement changes. Designed for both beginners and experienced developers, this starter kit serves as an invaluable tool for launching comprehensive Web3 applications quickly.
Features
Integrated Environment: The kit uses a monorepo structure with
pnpmfor package management, allowing developers to run API, clients, and contracts simultaneously in a local environment.Multiple Dependencies: Requires Node version 18+, PNPM version 6+, Docker for database services such as Postgres and Redis, and Foundry for smart contract management.
Flexible Architecture: Packages are separated by functionality, with singletons for API and contract packages while clients adapt to various interfaces, such as web and mobile.
Testing Framework: Comprehensive testing capabilities with vitest for client tests, Supertest and Jest for API tests, and Solidity for contract tests, ensuring robust application validation.
Language Support: Built using TypeScript for both client and API code, enhancing type safety and reducing runtime errors, while Solidity is used for Ethereum contract creation.
Core Libraries: Utilizes essential libraries like React for UI rendering, Vite for client UI builds, and Express for server management, offering a solid foundation for development.
Open Source Contribution: Encourages contributions from the community, providing a clear process for developers to fork the repo, address issues, and submit enhancements.
Autonomous Worlds with Mud: Incorporates unique features like Mud for creating on-chain autonomous worlds, enriching the capabilities of the starter kit.