Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Manta-Network/react-dapp-starter
https://github.com/Manta-Network/react-dapp-starter
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/Manta-Network/react-dapp-starter
- Owner: Manta-Network
- Created: 2024-06-03T15:56:04.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-11-07T06:31:30.000Z (2 months ago)
- Last Synced: 2024-11-07T07:23:38.573Z (2 months ago)
- Language: TypeScript
- Homepage: https://react-dapp-starter.vercel.app
- Size: 610 KB
- Stars: 8
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome - Manta-Network/react-dapp-starter - (TypeScript)
- fucking-awesome-vite - React Dapp Starter - Enterprise-ready Web3 DApp starter with `TypeScript`, `TailwindCSS`, `Web3Modal`, `Wagmi`, `Shadcn UI`, `Zustand`, and `TanStack Query` for scalable decentralized applications. (Get Started / Templates)
- awesome-vite - React Dapp Starter - Enterprise-ready Web3 DApp starter with `TypeScript`, `TailwindCSS`, `Web3Modal`, `Wagmi`, `Shadcn UI`, `Zustand`, and `TanStack Query` for scalable decentralized applications. (Get Started / Templates)
README
# React DApp Starter
## Overview
`react-dapp-starter` is a robust and scalable template designed for building decentralized applications (DApps) with modern web technologies. This template is a production-ready foundation currently used in [Manta Network](https://manta.network/), designed to meet the demands of complex and scalable DApp development.
## Features
- **[TypeScript](https://www.typescriptlang.org/)**: Strongly-typed language that builds on JavaScript, giving you better tooling at any scale.
- **[React Router](https://reactrouter.com/)**: A declarative routing library for React that makes it easy to navigate your app.
- **[TailwindCSS](https://tailwindcss.com/)**: Utility-first CSS framework for rapid UI development.
- **[Web3Modal](https://docs.walletconnect.com/appkit/react/core/installation)**: An easy-to-use library for integrating multiple wallet providers.
- **[Wagmi](https://wagmi.sh/)**: A set of React Hooks for working with Ethereum.
- **[Viem](https://viem.sh/)**: A toolkit for handling Ethereum-related data and logic.
- **[Shadcn UI](https://ui.shadcn.com/)**: A collection of pre-built UI components for a fast and consistent development experience.
- **[Zustand](https://github.com/pmndrs/zustand)**: A small, fast, and scalable state management solution for React.
- **[TanStack Query](https://tanstack.com/query/latest/docs/framework/react/overview)**: Powerful data fetching, caching, and synchronization for server state management.
- **ESLint & Prettier**: Code quality and formatting tools to ensure a clean codebase.
## Getting Started
1. **Clone the repository:**
You can use a tool like [degit](https://github.com/Rich-Harris/degit) to scaffold your project with this template.
```bash
npx degit Manta-Network/react-dapp-starter#main your-project
cd your-project
```
2. **Install dependencies (default: yarn):**
```bash
yarn install
```
3. **Configure WalletConnect Project ID and Metadata:**
- Visit [WalletConnect Cloud](https://cloud.walletconnect.com) to create a project and obtain your `Project ID`.
- Open the file `src/config/common.ts` in your project.
- Locate the `WALLET_CONNECT_PROJECT_ID` key and replace `YOUR_PROJECT_ID` with your actual `Project ID`.
- Update the `WALLET_CONNECT_METADATA` section with your project's details, including the name, description, URL, and icons.
4. **Run the development server:**
```bash
yarn dev
```
5. **Build for production:**
```bash
yarn build
```
## Project Structure
```plaintext
├── src/
│ ├── abis/ # Smart contract ABIs
│ ├── api/ # Optional API endpoints definitions
│ ├── assets/ # Static assets like images and fonts
│ ├── components/ # Reusable UI components
│ ├── config/ # Application configuration files
│ ├── hooks/ # Custom React hooks
│ ├── lib/ # Utility functions and business logic
│ ├── pages/ # Application pages
│ ├── store/ # Global state management using Zustand
│ ├── types/ # TypeScript types
│ ├── AppRouter.tsx # Application routing
│ ├── index.scss # Global styles
│ ├── main.tsx # Main entry point
│ └── vite-env.d.ts # Vite environment variables types
├── public/ # Static public assets
├── .eslintrc.cjs # ESLint configuration
├── .gitignore # Git ignore file
├── .prettierrc # Prettier configuration
├── CHANGELOG.md # Project changelog
├── components.json # Shadcn UI components configuration
├── index.html # Main HTML file
├── package.json # Project metadata and dependencies
├── postcss.config.js # PostCSS configuration
├── PROJECT_OVERVIEW.md # Overview of the project
├── README.md # Project README
├── tailwind.config.js # Tailwind CSS configuration
├── tsconfig.json # TypeScript configuration
├── tsconfig.node.json # Node.js TypeScript configuration
├── vercel.json # Vercel deployment configuration
├── vite.config.ts # Vite configuration
└── yarn.lock # Yarn lock file
```
## Contributing
Contributions are welcome! Please create an issue or submit a pull request if you find any bugs or have suggestions for improvements.
## Acknowledgements
Special thanks to the open-source community and the maintainers of the libraries and tools used in this template.