Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abhisheknaiidu/superfluid-integration-app
https://github.com/abhisheknaiidu/superfluid-integration-app
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/abhisheknaiidu/superfluid-integration-app
- Owner: abhisheknaiidu
- License: mit
- Created: 2023-06-12T07:25:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-12T07:25:59.000Z (over 1 year ago)
- Last Synced: 2024-04-15T05:05:29.449Z (7 months ago)
- Language: TypeScript
- Size: 1.27 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚡ TurboETH - Web3 App Template
Web3 App Template built using Next.js, RainbowKit, SIWE, Disco, and more!
### Starter Kit Examples
- [Main](https://light.turboeth.xyz) - `main` branch
- [Heavy](https://turboeth.xyz) - `integrations` branch
Deploy TurboETH `main` directly to [Vercel](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fturbo-eth%2Ftemplate-web3-app&project-name=TurboETH&repository-name=turbo-eth&demo-title=TurboETH&env=NEXTAUTH_SECRET,DATABASE_URL&envDescription=How%20to%20get%20these%20env%20variables%3A&envLink=https%3A%2F%2Fgithub.com%2Fturbo-eth%2Ftemplate-web3-app%2Fblob%2Fmain%2F.env.example)
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fturbo-eth%2Ftemplate-web3-app&project-name=TurboETH&repository-name=turbo-eth&demo-title=TurboETH&env=NEXTAUTH_SECRET,DATABASE_URL&envDescription=How%20to%20get%20these%20env%20variables%3A&envLink=https%3A%2F%2Fgithub.com%2Fturbo-eth%2Ftemplate-web3-app%2Fblob%2Fmain%2F.env.example)
### [Documentation](https://docs.turboeth.xyz)
- Getting Started
- [Environment Variables](https://docs.turboeth.xyz/getting-started/environment)
- [JSON-RPC](https://docs.turboeth.xyz/getting-started/json-rpc)
- [WAGMI CLI](https://docs.turboeth.xyz/getting-started/wagmi-cli)
- [UI Components](https://docs.turboeth.xyz/getting-started/design-system)
- [Backend Database](https://docs.turboeth.xyz/getting-started/database)
- Core Integrations
- [🌈 RainbowKit](https://docs.turboeth.xyz/integration/rainbowkit)
- [🔏 Sign-In With Ethereum](https://docs.turboeth.xyz/integration/sign-in-with-ethereum)
- Smart Contract Integrations
- [ERC20](https://docs.turboeth.xyz/integration/smart-contract-erc20)
- API Integrations
- [Disco](https://docs.turboeth.xyz/integration/disco)
- [Etherscan](https://docs.turboeth.xyz/integration/etherscan)
# Getting Started
The `pnpm` CLI is the recommended package manager but `npm` and `yarn` should work too.
```bash
pnpm install
```
#### Development
```bash
pnpm dev
```
#### Build
```bash
pnpm build
```
### Web3 Core
- [WAGMI CLI](https://wagmi.sh/cli/getting-started) - Automatic React Hook Generation
- [RainbowKit](https://www.rainbowkit.com/) - Wallet connection manager
- [Sign-In With Ethereum](https://login.xyz/) - Account authentication
### Web2 Frameworks
- [Vercel](https://vercel.com/) - App Infrastructure
- [Prisma](https://www.prisma.io/) - Database ORM
### Developer Experience
- [TypeScript](https://www.typescriptlang.org/) – Static type checker for end-to-end typesafety
- [Prettier](https://prettier.io/) – Opinionated code formatter for consistent code style
- [ESLint](https://eslint.org/) – Pluggable linter for Next.js and TypeScript
### User Interface
- [TailwindCSS](https://tailwindcss.com) – Utility-first CSS framework for rapid UI development
- [Radix](https://www.radix-ui.com/) – Primitives like modal, popover, etc. to build a stellar user experience
- [Framer Motion](https://www.framer.com/motion/) – Motion library for React to animate components with ease
- [Lucide](https://lucide.dev/docs/lucide-react) – Beautifully simple, pixel-perfect icons
The [ui.shadcn.com](https://ui.shadcn.com) components are included in the `/components/shared/ui` folder.
# 💻 Developer Experience
### 🐕 What is husky
Husky improves your git commits.
You can use it to lint your commit messages, run tests, lint code, etc... when you commit or push. Husky supports all Git hooks.
#### 🪝 Hooks
- pre-commit: lint app codebase
- commit-msg: apply commintlint
### 📋 What is commitlint
commitlint checks if your commit messages meet the [conventional commit format](https://conventionalcommits.org).
In general the pattern mostly looks like this:
```sh
type(scope?): subject #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")
```
Real world examples can look like this:
```
chore: run tests on travis ci
```
```
fix(server): send cors headers
```
```
feat(blog): add comment section
```
Common types according to [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum) can be:
- build
- chore
- ci
- docs
- feat
- fix
- perf
- refactor
- revert
- style
- test
# Acknowledgements
Original template was forked from https://github.com/wslyvh/nexth
Thank you @wslyvh 🙏
Copyright 2023 [Kames Geraghty](https://twitter.com/KamesGeraghty)