87 lines
2.4 KiB
Markdown
87 lines
2.4 KiB
Markdown
# kk
|
|
|
|
This project was created with [Better-T-Stack](https://github.com/AmanVarshney01/create-better-t-stack), a modern TypeScript stack that combines React, TanStack Start, Self, ORPC, and more.
|
|
|
|
## Features
|
|
|
|
- **TypeScript** - For type safety and improved developer experience
|
|
- **TanStack Start** - SSR framework with TanStack Router
|
|
- **TailwindCSS** - Utility-first CSS for rapid UI development
|
|
- **shadcn/ui** - Reusable UI components
|
|
- **oRPC** - End-to-end type-safe APIs with OpenAPI integration
|
|
- **Drizzle** - TypeScript-first ORM
|
|
- **SQLite/Turso** - Database engine
|
|
- **Authentication** - Better-Auth
|
|
- **Turborepo** - Optimized monorepo build system
|
|
- **Biome** - Linting and formatting
|
|
|
|
## Getting Started
|
|
|
|
First, install the dependencies:
|
|
|
|
```bash
|
|
bun install
|
|
```
|
|
|
|
## Database Setup
|
|
|
|
This project uses SQLite with Drizzle ORM.
|
|
|
|
1. Start the local SQLite database (optional):
|
|
|
|
```bash
|
|
bun run db:local
|
|
```
|
|
|
|
2. Update your `.env` file in the `apps/web` directory with the appropriate connection details if needed.
|
|
|
|
3. Apply the schema to your database:
|
|
|
|
```bash
|
|
bun run db:push
|
|
```
|
|
|
|
Then, run the development server:
|
|
|
|
```bash
|
|
bun run dev
|
|
```
|
|
|
|
Open [http://localhost:3001](http://localhost:3001) in your browser to see the fullstack application.
|
|
|
|
## Deployment (Cloudflare via Alchemy)
|
|
|
|
- Dev: cd apps/web && bun run alchemy dev
|
|
- Deploy: cd apps/web && bun run deploy
|
|
- Destroy: cd apps/web && bun run destroy
|
|
|
|
For more details, see the guide on [Deploying to Cloudflare with Alchemy](https://www.better-t-stack.dev/docs/guides/cloudflare-alchemy).
|
|
|
|
## Git Hooks and Formatting
|
|
|
|
- Format and lint fix: `bun run check`
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
kk/
|
|
├── apps/
|
|
│ └── web/ # Fullstack application (React + TanStack Start)
|
|
├── packages/
|
|
│ ├── api/ # API layer / business logic
|
|
│ ├── auth/ # Authentication configuration & logic
|
|
│ └── db/ # Database schema & queries
|
|
```
|
|
|
|
## Available Scripts
|
|
|
|
- `bun run dev`: Start all applications in development mode
|
|
- `bun run build`: Build all applications
|
|
- `bun run check-types`: Check TypeScript types across all apps
|
|
- `bun run db:push`: Push schema changes to database
|
|
- `bun run db:generate`: Generate database client/types
|
|
- `bun run db:migrate`: Run database migrations
|
|
- `bun run db:studio`: Open database studio UI
|
|
- `bun run db:local`: Start the local SQLite database
|
|
- `bun run check`: Run Biome formatting and linting
|