initial commit
This commit is contained in:
64
README.md
Normal file
64
README.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# zendegi
|
||||
|
||||
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, 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
|
||||
- **Drizzle** - TypeScript-first ORM
|
||||
- **PostgreSQL** - Database engine
|
||||
- **Authentication** - Better-Auth
|
||||
- **Turborepo** - Optimized monorepo build system
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, install the dependencies:
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
## Database Setup
|
||||
|
||||
This project uses PostgreSQL with Drizzle ORM.
|
||||
|
||||
1. Make sure you have a PostgreSQL database set up.
|
||||
2. Update your `apps/web/.env` file with your PostgreSQL connection details.
|
||||
|
||||
3. Apply the schema to your database:
|
||||
|
||||
```bash
|
||||
pnpm run db:push
|
||||
```
|
||||
|
||||
Then, run the development server:
|
||||
|
||||
```bash
|
||||
pnpm run dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3001](http://localhost:3001) in your browser to see the fullstack application.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
zendegi/
|
||||
├── apps/
|
||||
│ └── web/ # Fullstack application (React + TanStack Start)
|
||||
├── packages/
|
||||
│ ├── auth/ # Authentication configuration & logic
|
||||
│ └── db/ # Database schema & queries
|
||||
```
|
||||
|
||||
## Available Scripts
|
||||
|
||||
- `pnpm run dev`: Start all applications in development mode
|
||||
- `pnpm run build`: Build all applications
|
||||
- `pnpm run check-types`: Check TypeScript types across all apps
|
||||
- `pnpm run db:push`: Push schema changes to database
|
||||
- `pnpm run db:generate`: Generate database client/types
|
||||
- `pnpm run db:migrate`: Run database migrations
|
||||
- `pnpm run db:studio`: Open database studio UI
|
||||
Reference in New Issue
Block a user