https://github.com/servrox/1337-turbo-starter
1337 Turbo Starter is a modern full-stack Web3 monorepo powered by Turborepo, integrating the official Aptos DApp boilerplate.
https://github.com/servrox/1337-turbo-starter
Last synced: about 1 year ago
JSON representation
1337 Turbo Starter is a modern full-stack Web3 monorepo powered by Turborepo, integrating the official Aptos DApp boilerplate.
- Host: GitHub
- URL: https://github.com/servrox/1337-turbo-starter
- Owner: servrox
- Created: 2025-03-23T12:22:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-05T14:50:59.000Z (about 1 year ago)
- Last Synced: 2025-04-09T22:56:10.383Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://1337-turbo-starter-aptos-boilerplate.vercel.app
- Size: 370 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 1337 Turbo Starter โ Modern Web3 Development Stack
---
## ๐ Overview
**1337 Turbo Starter** is a modern full-stack Web3 monorepo powered by [Turborepo](https://turbo.build/), integrating the official [Aptos DApp boilerplate](https://learn.aptoslabs.com/en/dapp-templates/boilerplate-template).
It runs:
- โก๏ธ Bun for ultra-fast performance
- ๐จ Tailwind CSS + shadcn/ui for polished UIs
- ๐ Aptos & Move for next level Web3
- ๐งฑ Shared configs & UI across apps
- ๐ฆช Developer-first tooling and monorepo structure
---
## ๐งฐ Tech Stack
- **Bun** โ Ultra-fast JS runtime & package manager
- **Turborepo** โ High-performance monorepo build system
- **Next.js** โ React framework for production apps
- **Tailwind CSS** โ Utility-first CSS framework
- **Aptos** โ Layer 1 blockchain platform
- **Move** โ Safe, resource-oriented smart contract language
---
## ๐ Project Structure
```txt
.
โโโ apps/
โ โโโ aptos-boilerplate/ # Aptos DApp implementation
โ โโโ landing-page/ # Landing page application
โโโ packages/
โ โโโ contract/ # Move smart contracts
โ โโโ ui/ # Shared UI components
โ โโโ typescript-config/ # Shared TypeScript settings
โ โโโ eslint-config/ # Shared ESLint rules
โโโ .vscode/ # VS Code configuration
```
๐ฆ **Shared packages** ensure consistent styling, types, and components across all applications.
---
## โ๏ธ Getting Started
### Prerequisites
- [Bun](https://bun.sh) โฅ 1.2.5
- [VS Code](https://code.visualstudio.com) (recommended)
### ๐งช Installation
```bash
git clone git@github.com:servrox/1337-turbo-starter.git
cd 1337-turbo-starter
bun install
```
### ๐ Environment Setup
**For the Aptos DApp (`apps/aptos-boilerplate/.env`):**
```env
# Get your API key from https://build.aptoslabs.com
NEXT_PUBLIC_APTOS_API_KEY=your_api_key_here
```
**For the Move contract (`packages/contract/.env`):**
```env
NEXT_MODULE_PUBLISHER_ACCOUNT_PRIVATE_KEY=your_private_key_here
NEXT_PUBLIC_MODULE_ADDRESS=your_module_address_here
```
๐ `NEXT_MODULE_PUBLISHER_ACCOUNT_ADDRESS` will be set automatically when you run:
```bash
bun run move:publish
```
### โถ๏ธ Start Dev Server
```bash
bun run dev
```
---
## ๐ Scripts
| Script | Description |
|--------------------------------|------------------------------------------------|
| `bun run build` | Build all apps and packages |
| `bun run build:aptos-boilerplate` | Build only the Aptos boilerplate app |
| `bun run build:landing-page` | Build only the landing page |
| `bun run dev` | Start all development servers |
| `bun run dev:aptos-boilerplate`| Start Aptos boilerplate development server |
| `bun run dev:landing-page` | Start landing page development server |
| `bun run lint` | Run ESLint across the repo |
| `bun run check-types` | Type-check all packages and apps |
| `bun run format` | Format codebase with Prettier |
---
## โจ Bonus
- โก๏ธ **Fast Dev Workflow** with Bun and Turborepo
- ๐จ **4-way theme switcher** select between banana, dark, light and system
- ๐ฆ **Shared UI Components** via `@repo/ui`
- ๐ง **Developer Experience**: Prettier, ESLint, TypeScript, and VS Code settings out-of-the-box
- ๐ **Tailwind v4**: full tailwind v4 style with css only configs
- ๐ฑ **shadcn/ui monorepo** using shadcn/ui components and CLI in a [monorepo](https://ui.shadcn.com/docs/monorepo#requirements)
- ๐ **create-aptos-dapp** matched Aptos Move integration with the official AptosLabs boilerplate
---
## ๐ญ Development Guidelines
### Required Environment Variables
| Location | Variable | Description |
|----------------------------|------------------------------------------------|-----------------------------------------------------------|
| `apps/aptos-boilerplate/.env` | `NEXT_PUBLIC_APP_NETWORK` | The network your module is deployed to |
| `apps/aptos-boilerplate/.env` | `NEXT_PUBLIC_MODULE_ADDRESS` | **Auto-filled** by `move:publish` script |
| `apps/aptos-boilerplate/.env` | `NEXT_PUBLIC_APTOS_API_KEY` | Your Aptos API key from [Aptos Labs](https://build.aptoslabs.com) |
| `packages/contract/.env` | `NEXT_PUBLIC_APP_NETWORK` | The network you want to deploy your module |
| `packages/contract/.env` | `NEXT_MODULE_PUBLISHER_ACCOUNT_ADDRESS` | Account address used for module publishing |
| `packages/contract/.env` | `NEXT_PUBLIC_MODULE_ADDRESS` | **Auto-filled** by `move:publish` script |
| `packages/contract/.env` | `NEXT_MODULE_PUBLISHER_ACCOUNT_PRIVATE_KEY` | Private key used for module publishing |
๐ก See the `.env.example` files in each package for more details.
๐ก If you are using the Testnet network, you will need to fund a module publisher account manually through the faucet web view on https://aptos.dev/en/network/faucet and then fill out the `NEXT_MODULE_PUBLISHER_ACCOUNT_PRIVATE_KEY` and `NEXT_MODULE_PUBLISHER_ACCOUNT_ADDRESS` in your project .env file.