mirror of
https://github.com/FranP-code/create-better-t-stack.git
synced 2025-10-12 23:52:15 +00:00
119 lines
4.5 KiB
Plaintext
119 lines
4.5 KiB
Plaintext
---
|
|
title: Getting Started
|
|
description: A modern CLI tool for scaffolding end-to-end type-safe TypeScript projects with best practices and customizable configurations
|
|
---
|
|
|
|
> ⚠️ **Warning:** Documentation is a work in progress.
|
|
|
|
## What is Better-T-Stack?
|
|
|
|
Better-T-Stack is designed to eliminate the complexity of setting up modern TypeScript projects. Instead of spending hours configuring build tools, type systems, databases, and deployment pipelines, you can get a production-ready project structure in minutes.
|
|
|
|
### Key Features
|
|
|
|
- **🏗️ Full-Stack Ready**: Choose from multiple frontend and backend frameworks
|
|
- **🔒 End-to-End Type Safety**: TypeScript across your entire application stack
|
|
- **🗄️ Database Integration**: Support for SQLite, PostgreSQL, MySQL, and MongoDB
|
|
- **🔐 Built-in Authentication**: Email/password auth with Better-Auth
|
|
- **📱 Multi-Platform**: Web, mobile (React Native), and desktop (Tauri) support
|
|
- **☁️ Deployment Ready**: Configured for modern hosting platforms
|
|
- **⚡ Modern Tooling**: Latest versions of your favorite tools and frameworks
|
|
|
|
### Supported Technologies
|
|
|
|
#### Frontend Frameworks
|
|
- **React** with TanStack Router or React Router
|
|
- **Next.js** - Full-stack React framework
|
|
- **SvelteKit** - Web framework for Svelte
|
|
- **Nuxt** - Vue.js framework
|
|
- **SolidJS** - Performant reactive framework
|
|
- **TanStack Start** - SSR with TanStack Router
|
|
- **React Native** - Mobile development with Expo
|
|
|
|
#### Backend Frameworks
|
|
- **Hono** - Lightweight, ultrafast web framework
|
|
- **Express** - Popular Node.js framework
|
|
- **Fastify** - Fast, low-overhead framework
|
|
- **Elysia** - Type-safe, high-performance framework
|
|
- **Convex** - Reactive backend-as-a-service
|
|
- **Next.js API Routes** - Full-stack React
|
|
|
|
#### Databases & ORMs
|
|
- **Databases**: SQLite/Turso, PostgreSQL, MySQL, MongoDB
|
|
- **ORMs**: Drizzle (TypeScript-first), Prisma (feature-rich), Mongoose
|
|
- **Hosting**: Neon, Supabase, MongoDB Atlas, Cloudflare D1
|
|
|
|
#### API Layers
|
|
- **tRPC** - End-to-end type-safe APIs
|
|
- **oRPC** - OpenAPI-compatible type-safe APIs
|
|
|
|
### Why Choose Better-T-Stack?
|
|
|
|
#### Traditional Setup Problems
|
|
- ⏰ Hours of configuration and setup
|
|
- 🔧 Complex toolchain integration
|
|
- 📚 Overwhelming technology choices
|
|
- 🐛 Configuration bugs and compatibility issues
|
|
- 🏗️ Inconsistent project structures
|
|
|
|
#### Better-T-Stack Solutions
|
|
- ⚡ **Quick Setup**: Get started in under 2 minutes
|
|
- 🎯 **Curated Choices**: Pre-selected, compatible technology combinations
|
|
- 📋 **Best Practices**: Industry-standard configurations out of the box
|
|
- 🔄 **Consistent Structure**: Standardized monorepo organization
|
|
- 🧪 **Battle-Tested**: Configurations used in production applications
|
|
|
|
## Quick Example
|
|
|
|
```bash
|
|
# Create a new project
|
|
npx create-better-t-stack@latest my-app
|
|
|
|
# Choose your stack interactively or use flags
|
|
npx create-better-t-stack@latest my-app \
|
|
--frontend tanstack-router \
|
|
--backend hono \
|
|
--database postgres \
|
|
--orm drizzle \
|
|
--auth \
|
|
--addons pwa turborepo
|
|
```
|
|
|
|
## Project Types
|
|
|
|
Better-T-Stack supports various project configurations:
|
|
|
|
### Full-Stack Web Applications
|
|
Perfect for modern web apps with React, Vue, or Svelte frontends backed by type-safe APIs.
|
|
|
|
### Mobile Applications
|
|
Build React Native apps with Expo, sharing type definitions with your backend.
|
|
|
|
### Desktop Applications
|
|
Create cross-platform desktop apps using Tauri with your web frontend.
|
|
|
|
### API-Only Projects
|
|
Build standalone APIs and microservices with your preferred backend framework.
|
|
|
|
### Monorepo Projects
|
|
Organize multiple applications (web, mobile, API) in a single repository with shared packages.
|
|
|
|
## Who Should Use Better-T-Stack?
|
|
|
|
- **Indie Developers**: Quickly prototype and build full-stack applications
|
|
- **Startups**: Get to market faster with production-ready project structure
|
|
- **Teams**: Standardize project setup across your organization
|
|
- **Students**: Learn modern full-stack development with best practices
|
|
- **Agencies**: Rapidly scaffold client projects with consistent quality
|
|
|
|
## What's Next?
|
|
|
|
Ready to get started? Check out our [Quick Start Guide](/docs/quick-start) to create your first Better-T-Stack project, or explore the [Configuration Options](/docs/frontend) to learn about all available technologies and features.
|
|
|
|
### Need Help?
|
|
|
|
- 📖 **Documentation**: Comprehensive guides and references
|
|
- 🐛 **Issues**: Report bugs on [GitHub](https://github.com/AmanVarshney01/create-better-t-stack/issues)
|
|
- 💬 **Discussions**: Community support and questions
|
|
- 🌟 **Star us**: Show support on [GitHub](https://github.com/AmanVarshney01/create-better-t-stack)
|