{"id":19289846,"url":"https://github.com/suiware/sui-dapp-starter","last_synced_at":"2025-04-22T05:31:53.576Z","repository":{"id":237637028,"uuid":"794883099","full_name":"suiware/sui-dapp-starter","owner":"suiware","description":"Easy-to-Use Full-Stack Sui Starter","archived":false,"fork":false,"pushed_at":"2025-04-17T11:30:51.000Z","size":1049,"stargazers_count":49,"open_issues_count":5,"forks_count":13,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-18T01:53:49.909Z","etag":null,"topics":["blockcahin","boilerplate","starter","starter-template","sui","sui-blockchain","sui-boilerplate","sui-dapp","sui-dapp-starter","suiware"],"latest_commit_sha":null,"homepage":"https://sui-dapp-starter.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/suiware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-05-02T06:35:53.000Z","updated_at":"2025-04-17T15:25:41.000Z","dependencies_parsed_at":"2024-05-02T22:10:19.157Z","dependency_job_id":"71df40a3-3b2c-44ae-a324-c5f5b2a8d41a","html_url":"https://github.com/suiware/sui-dapp-starter","commit_stats":null,"previous_names":["kkomelin/sui-starter","suiware/sui-dapp-starter","kkomelin/sui-dapp-starter"],"tags_count":22,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiware%2Fsui-dapp-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiware%2Fsui-dapp-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiware%2Fsui-dapp-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiware%2Fsui-dapp-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/suiware","download_url":"https://codeload.github.com/suiware/sui-dapp-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250175070,"owners_count":21387132,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockcahin","boilerplate","starter","starter-template","sui","sui-blockchain","sui-boilerplate","sui-dapp","sui-dapp-starter","suiware"],"created_at":"2024-11-09T22:17:21.269Z","updated_at":"2025-04-22T05:31:53.554Z","avatar_url":"https://github.com/suiware.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sui dApp Starter - Easy-to-Use Full-Stack Sui Starter\n[![Build and Lint (frontend)](https://github.com/suiware/sui-dapp-starter/actions/workflows/build_and_lint.yaml/badge.svg)](https://github.com/suiware/sui-dapp-starter/actions/workflows/build_and_lint.yaml)\n[![Discord chat](https://img.shields.io/discord/1237259509366521866.svg?logo=discord\u0026style=flat-square)](https://discord.com/invite/HuDPpXz4Hx)\n\n![Spoiler](https://repository-images.githubusercontent.com/794883099/f0937c6b-c021-41db-b44a-a287b29111c3)\n\n[Won the 1st place in the Randomness category of the Sui Overflow 2024 hackathon](https://blog.sui.io/2024-sui-overflow-hackathon-winners/)\n\n## Motivation\n\nMost of the Sui starters I found were either very basic or one-sided (frontend or backend). Thanks to my experience with various full-stack starters and templates, I knew how to do better, so I started this template with the goal of providing all basic tools and components for you to focus on your business logic from day one and not spend weeks on creating your app skeleton. // [@kkomelin](https://github.com/kkomelin)\n\n## Features\n\n- **[Suibase](https://suibase.io/)**: Painless work with the networks and system dependencies\n- **[Local Sui Explorer](https://github.com/suiware/sui-explorer)**: Browse your transactions and objects locally\n- **pnpm**: More efficient package management for monorepos\n- **TypeScript**: Less error-prone JavaScript\n- **React or Next.js**: Choose a template with a framework of your choice\n- **Tailwind CSS**: Utility-first CSS for more efficient styling\n- **Vite + SWC**: Faster app bundling and optimizing\n- **Radix UI**: Accessible React components to prototype quicker \n- **Sui dApp Kit**: All you need to work with Sui network on frontend\n- **[@suiware/kit](https://www.npmjs.com/package/@suiware/kit)**: Useful react primitives, such as useTransact, useNetworkType, NetworkType, useBalance, Balance, useFaucet, Faucet and more\n- **Frontend Deployment**: [Firebase](https://sui-dapp-starter.dev/docs/frontend/deployment/firebase), [Walrus Sites](https://sui-dapp-starter.dev/docs/frontend/deployment/walrus), [Arweave](https://sui-dapp-starter.dev/docs/frontend/deployment/arweave)\n- **One-liner Install**: Just `pnpm create sui-dapp@latest`\n- **[Demo app](https://demo.sui-dapp-starter.dev/)**: Default Greeting (React) template\n\n## Prerequisites\n\nBefore you begin, install the following:\n\n- [Suibase](https://suibase.io/how-to/install.html)\n- [Node (\u003e= 20)](https://nodejs.org/en/download/)\n- [pnpm (\u003e= 9)](https://pnpm.io/installation)\n\n## Installation\n\n### Option 1. Use the Github template\n\n1. [Create a new project from the template](https://github.com/new?template_name=sui-dapp-starter\u0026template_owner=suiware\u0026name=my-sui-dapp).\n\n2. Clone the resulting repo locally.\n\n3. Choose a template by running the corresponding init command:\n\n| Template | Init command |\n| --- | --- |\n| Greeting (React) | `pnpm init:template:greeting-react` |\n| Greeting (Next.js) | `pnpm init:template:greeting-next` |\n| Counter (React) | `pnpm init:template:counter-react` |\n\n[Template Guide](https://sui-dapp-starter.dev/docs/templates)\n\n### Option 2. Use CLI\n\n```bash\npnpm create sui-dapp@latest\n```\n\nThis way you'll be able to configure the project step-by-step.\n\n## Usage\n\n#### 1. Run the local Sui network:\n\n```bash\npnpm localnet:start\n```\n\nLocal Sui Explorer will be available on [localhost:9001](http://localhost:9001/)\n\n#### 2. Deploy the demo contract to the local network:\n\n```bash\npnpm localnet:deploy\n```\n\n_This command skips dependency verifications to prevent dependency version mismatch issues, which are caused by local and remote Sui version mismatch. The deploy commands for devnet, testnet and mainnet do perform such verifications._\n\n#### 3. Switch to the local network in your browser wallet settings.\n\n#### 4. Fund your localnet account/address:\n\nYou have a few options here:\n\na) Use the Faucet button integrated into your wallet (e.g. Sui Wallet).\n\nb) Copy the localnet address from your wallet and run the following in your console:\n\n```bash\npnpm localnet:faucet 0xYOURADDRESS\n```\n\nc) Run the app and use the Faucet button in the footer.\n\n#### 5. Run the app:\n\n```bash\npnpm start\n```\nFind all commands in the [documentation](https://sui-dapp-starter.dev/docs/misc/commands/).\n\n## Test\n\n#### Backend\n\n```bash\npnpm test\n```\n\n## Docs \u0026 Support\n\n- [Sui dApp Starter Docs](https://sui-dapp-starter.dev/docs)\n- [Available PNPM Commands](https://sui-dapp-starter.dev/docs/misc/commands/)\n- [@suiware/kit Docs](https://www.npmjs.com/package/@suiware/kit)\n- [Discord Support](https://discord.com/invite/HuDPpXz4Hx)  \n\n## Useful Links\n\n- [Useful VSCode Extensions](./.vscode/extensions.json)\n- [Suibase Docs](https://suibase.io/intro.html)\n- [Move Book](https://move-book.com/)\n- [Sui Move: Code Conventions](https://docs.sui.io/concepts/sui-move-concepts/conventions)\n- [@mysten/create-dapp - official starter](https://www.npmjs.com/package/@mysten/create-dapp)\n- [Awesome Sui](https://github.com/sui-foundation/awesome-sui)\n\n## License \u0026 Copyright\n\nCopyright (c) 2024 Konstantin Komelin and other contributors\n\nCode is licensed under [MIT](https://github.com/suiware/sui-dapp-starter?tab=MIT-1-ov-file)\n\nSVG Graphics used for NFTs is licensed under [CC-BY 4.0](https://github.com/suiware/sui-dapp-starter?tab=CC-BY-4.0-2-ov-file)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuiware%2Fsui-dapp-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuiware%2Fsui-dapp-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuiware%2Fsui-dapp-starter/lists"}