Skip to content

README.md

Latest commit

 

History

History
111 lines (83 loc) · 3.28 KB

README.md

File metadata and controls

111 lines (83 loc) · 3.28 KB

Nextellar

Nextellar is a one-step CLI toolkit that bootstraps a production-ready Next.js + TypeScript application with built-in Stellar blockchain support. Scaffold a full-stack dApp starter—complete with wallet connection, payment hooks, smart-contract integration, UI components, and best-practice defaults—so you can focus on features, not setup.

🚀 Features

  • One-step scaffold 
    npx nextellar my-app
  • Built-in Stellar support
    • Horizon & Soroban endpoints configured
    • Wallet-adapter plugin system (Freighter, XBull, Ledger, etc.)
  • React Hooks
    • useStellarAccount(), useStellarPayment(), useTrustlines(), useTransactionHistory(), useSorobanContract()
  • UI Components
    • <WalletConnectButton>, <BalanceDisplay>, <SendForm>, <ReceiveForm>, <TransactionList>, <NetworkSwitcher>, <TransactionStatusBadge>
  • Opinionated stack
    • Next.js (v13+ App Router) + TypeScript
    • Tailwind CSS + shadcn/ui
    • ESLint, Prettier, Jest + React Testing Library
    • Storybook for component previews
    • GitHub Actions CI for linting, testing, and build

📦 Installation

No global install required:

npx nextellar my-app
cd my-app
npm install
npm run dev

Or install globally:

npm install -g nextellar
nextellar my-app

⚙️ CLI Usage

Usage: nextellar <project-name> [options]

Options:
  -t, --typescript         Generate a TypeScript project (default)
  -j, --javascript         Generate a JavaScript project
  --horizon-url <url>      Override default Horizon endpoint
  --soroban-url <url>      Override default Soroban RPC endpoint
  -w, --wallets <list>     Comma-separated list of wallet adapters
  -d, --defaults           Skip prompts and use defaults
  --skip-install           Skip dependency installation after scaffolding
  --package-manager <pm>   Choose package manager (npm, yarn, pnpm)
  --install-timeout <ms>   Installation timeout in milliseconds (default: 1200000)
  -v, --version            Show CLI version
  -h, --help               Show help text

📁 Project Structure

my-app/
├── public/                     # Static assets (logos, icons)
├── src/
│   ├── app/                    # Next.js App Router (Layouts & Pages)
│   ├── components/             # Reusable UI components (WalletButton, etc)
│   ├── contexts/               # React Contexts (WalletProvider)
│   ├── hooks/                  # Custom Stellar hooks (useStellarAccount, etc)
│   └── lib/                    # Core logic and SDK initializations
├── tailwind.config.ts          # Styling configuration
├── tsconfig.json               # TypeScript configuration
├── package.json                # Project dependencies
└── README.md                   # You are here!

📖 Documentation

Full API reference, guides, and examples live at:
🔗 https://docs.nextellar.dev

Telemetry and privacy details:
🔗 docs/telemetry.md

🤝 Contributing

We welcome your help! Please read CONTRIBUTING.md for:

  • Issue & PR workflow
  • Branch naming conventions
  • Testing & linting guidelines

📜 License

MIT © 2025 Nextellar Labs