Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deco31416/boilerplate-deco31416
This boilerplate is a complete, optimized template for Web3 projects, designed for developers and startups looking to quickly integrate blockchain connections and financial services.
https://github.com/deco31416/boilerplate-deco31416
blockchain boliplate dapp metamask web3
Last synced: about 2 months ago
JSON representation
This boilerplate is a complete, optimized template for Web3 projects, designed for developers and startups looking to quickly integrate blockchain connections and financial services.
- Host: GitHub
- URL: https://github.com/deco31416/boilerplate-deco31416
- Owner: deco31416
- License: mit
- Created: 2024-10-30T21:16:28.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-31T02:16:53.000Z (2 months ago)
- Last Synced: 2024-10-31T03:19:28.023Z (2 months ago)
- Topics: blockchain, boliplate, dapp, metamask, web3
- Language: TypeScript
- Homepage: https://boilerplate-deco31416.vercel.app
- Size: 306 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Boilerplate - Deco31416
This boilerplate is designed for rapid integration and seamless connections within a web3 environment, making it ideal for developers, startups, and fintech companies aiming for quick MVP prototyping. With pre-configured integrations and comprehensive technical documentation, this template provides an efficient pathway for product integration, enabling swift validation and launch of projects.
## Project Structure
This boilerplate follows a modular project structure to facilitate scalability and maintainability. Below is a high-level overview:
- **public:** Public assets like images and icons.
- **src/components:** Contains reusable UI components, including the navbar, footer, modals, and UI elements like buttons.
- **src/pages:** Defines the main routes of the application using the page structure, allowing navigation and rendering of content based on the URL.
- **src/styles:** Global styles and Tailwind CSS configuration.
src/utils: Utility functions and helpers for various tasks.
public: Public assets like images and icons.
- **src/translations:** JSON files and configuration for managing multilingual content. This directory contains subfolders for each language (e.g., en, es) with translation files to provide language support.
This structure helps keep the code organized and makes it easy to add new features or expand existing ones.
## Folder Structure
```plaintext
Boilerplate-Deco31416-main/
├── public/
│ ├── Boilerplate-Header.svg
│ ├── favicon.ico
│ └── img/
│ ├── logo-40x40.png
│ ├── logo-487x487.png
│ ├── logo-500x500-Dark.png
│ └── metamask.png
├── src/
│ ├── components/
│ │ ├── Layout.tsx
│ │ ├── footer.tsx
│ │ ├── navbar.tsx
│ │ ├── modals/
│ │ │ ├── modals-cookies.tsx
│ │ │ ├── modals-welcome.tsx
│ │ │ └── styles.module.css
│ │ ├── ui/
│ │ │ ├── ConnectionStatusSwitch.tsx
│ │ │ ├── LanguageSwitcher.tsx
│ │ │ ├── MobileConnectButton.tsx
│ │ │ ├── MobileMenu.tsx
│ │ │ ├── ThemeToggle.tsx
│ │ │ ├── button.tsx
│ │ │ └── sheet.tsx
│ │ └── web3/
│ │ ├── abis/
│ │ │ ├── custody-bsc.abi.ts
│ │ │ └── token-bsc.abi.ts
│ │ ├── configs/
│ │ │ ├── chains.ts
│ │ │ └── tokens.ts
│ │ ├── providers/
│ │ │ └── wagmi-provider.tsx
│ │ └── types/
│ │ └── index.ts
│ ├── pages/
│ │ ├── _app.tsx
│ │ ├── _document.tsx
│ │ └── index.tsx
│ ├── styles/
│ │ ├── Home.module.css
│ │ └── globals.css
│ └── translations/
│ ├── i18n.js
│ ├── en/
│ │ └── translations.json
│ └── es/
│ └── translations.json
├── .eslintrc.json
├── .gitignore
├── .npmrc
├── .prettierrc
├── LICENSE.txt
├── README.md
├── next-env.d.ts
├── next.config.js
├── package-lock.json
├── package.json
├── postcss.config.js
├── settings.json
├── tailwind.config.js
└── tsconfig.json
```
## Technologies Used
- **Next.js**: Main framework for the application.
- **TypeScript**: Static typing to improve code quality.
- **Tailwind CSS**: For custom styles and responsive design.
- **Headless UI**: For interactive components without default styles.
- **RainbowKit**: Connection of Wallets and support for multiple networks.
- **Wagmi**: Management of blockchain networks, including Binance Smart Chain Testnet.
- **Binance Smart Chain (BSC) Testnet:** Pre-configured testnet for testing and development before deployment to the mainnet.
## SEO Optimization
Added SEO optimization tags and a clear content structure to improve search engine indexing.
## Deployment
MicaUSD is currently deployed on the Binance Smart Chain Testnet for testing and development. The contracts are available for review and audit in the repository.
### Installation
1. Clone this repository:
```bash
git clone https://github.com/deco31416/Boilerplate-Deco31416.git
```
2. Install the dependencies:
```bash
npm install
```
3. Run the development server:
```bash
npm run dev
```
## License
This project is protected under the [Creative Commons Attribution 3.0 license](https://creativecommons.org/licenses/by/3.0/us/deed.en), and the underlying source code used to format and display this content is licensed under the [MIT license](https://github.com/deco31416/Boilerplate-Deco31416/blob/main/LICENSE.txt).
## Developed by
**[Deco31416](https://github.com/deco31416)**
For more information, Visit: [deco31416.com](https://www.deco31416.com/)