update readme

This commit is contained in:
Aman Varshney
2025-03-27 01:28:43 +05:30
parent e021f501a8
commit 7353791c13
2 changed files with 81 additions and 58 deletions

View File

@@ -1,37 +1,42 @@
# Better-T-Stack
Better-T-Stack is a project scaffolding system for creating modern TypeScript applications with complete type safety from frontend to backend.
## Repository Structure
This repository is organized as a monorepo containing:
- **CLI**: [`create-better-t-stack`](apps/cli) - A scaffolding CLI that creates type-safe TypeScript projects
- **Documentation**: [`web`](apps/web) - The official website and documentation
A modern CLI tool for scaffolding end-to-end type-safe TypeScript projects with best practices and customizable configurations
## Quick Start
```bash
# Using npm
npx create-better-t-stack my-app
npx create-better-t-stack@latest
# Using bun
bunx create-better-t-stack my-app
bun create better-t-stack@latest
# Using pnpm
pnpm create better-t-stack@latest
```
## Features
- 🚀 Fast project setup with interactive CLI
- 📦 Complete TypeScript type safety from database to frontend
- 🗄️ Multiple database options (libSQL/PostgreSQL)
- 🧩 Choice of ORMs (Drizzle or Prisma)
- 🔒 Built-in authentication with Better-Auth
- 🐳 Optional Docker configuration
- 🔄 Optional GitHub Actions workflows
- ⚡️ **Zero-config setup** with interactive CLI wizard
- 🔄 **End-to-end type safety** from database to frontend via tRPC
- 🧱 **Modern stack** with React, Hono/Elysia, and TanStack libraries
- 🗃️ **Database flexibility** with SQLite (Turso) or PostgreSQL options
- 🛠️ **ORM choice** between Drizzle or Prisma
- 🔒 **Built-in authentication** with Better-Auth
- 📱 **Optional PWA support** for mobile-friendly applications
- 🖥️ **Desktop app capabilities** with Tauri integration
- 📦 **Monorepo architecture** powered by Turborepo
## Repository Structure
This repository is organized as a monorepo containing:
- **CLI**: [`create-better-t-stack`](apps/cli) - The scaffolding CLI tool
- **Documentation**: [`web`](apps/web) - Official website and documentation
## Documentation
Visit [better-t-stack.pages.dev](https://better-t-stack.pages.dev) for full documentation.
Visit [better-t-stack.pages.dev](https://better-t-stack.pages.dev) for full documentation, guides, and examples.
## Development
@@ -42,6 +47,15 @@ git clone https://github.com/better-t-stack/create-better-t-stack.git
# Install dependencies
bun install
# Start development
bun dev
# Start CLI development
bun dev:cli
# Start website development
bun dev:web
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Created by [Aman Varshney](https://github.com/AmanVarshney01) & [Nitish Singh](https://github.com/FgrReloaded)