103 lines
3.2 KiB
Markdown
103 lines
3.2 KiB
Markdown
# haushaltsApp
|
|
|
|
This project was created with [Better-T-Stack](https://github.com/AmanVarshney01/create-better-t-stack), a modern TypeScript stack that combines React, TanStack Router, Hono, and more.
|
|
|
|
## Features
|
|
|
|
- **TypeScript** - For type safety and improved developer experience
|
|
- **TanStack Router** - File-based routing with full type safety
|
|
- **React Native** - Build mobile apps using React
|
|
- **Expo** - Tools for React Native development
|
|
- **TailwindCSS** - Utility-first CSS for rapid UI development
|
|
- **Shared UI package** - shadcn/ui primitives live in `packages/ui`
|
|
- **Hono** - Lightweight, performant server framework
|
|
- **Bun** - Runtime environment
|
|
- **Drizzle** - TypeScript-first ORM
|
|
- **PostgreSQL** - Database engine
|
|
- **Authentication** - Better-Auth
|
|
- **Turborepo** - Optimized monorepo build system
|
|
|
|
## Getting Started
|
|
|
|
First, install the dependencies:
|
|
|
|
```bash
|
|
bun install
|
|
```
|
|
|
|
## Database Setup
|
|
|
|
This project uses PostgreSQL with Drizzle ORM.
|
|
|
|
1. Make sure you have a PostgreSQL database set up.
|
|
2. Update your `apps/server/.env` file with your PostgreSQL connection details.
|
|
|
|
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 web application.
|
|
Use the Expo Go app to run the mobile application.
|
|
The API is running at [http://localhost:3000](http://localhost:3000).
|
|
|
|
## UI Customization
|
|
|
|
React web apps in this stack share shadcn/ui primitives through `packages/ui`.
|
|
|
|
- Change design tokens and global styles in `packages/ui/src/styles/globals.css`
|
|
- Update shared primitives in `packages/ui/src/components/*`
|
|
- Adjust shadcn aliases or style config in `packages/ui/components.json` and `apps/web/components.json`
|
|
|
|
### Add more shared components
|
|
|
|
Run this from the project root to add more primitives to the shared UI package:
|
|
|
|
```bash
|
|
npx shadcn@latest add accordion dialog popover sheet table -c packages/ui
|
|
```
|
|
|
|
Import shared components like this:
|
|
|
|
```tsx
|
|
import { Button } from "@haushaltsApp/ui/components/button";
|
|
```
|
|
|
|
### Add app-specific blocks
|
|
|
|
If you want to add app-specific blocks instead of shared primitives, run the shadcn CLI from `apps/web`.
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
haushaltsApp/
|
|
├── apps/
|
|
│ ├── web/ # Frontend application (React + TanStack Router)
|
|
│ ├── native/ # Mobile application (React Native, Expo)
|
|
│ └── server/ # Backend API (Hono)
|
|
├── packages/
|
|
│ ├── ui/ # Shared shadcn/ui components and styles
|
|
│ ├── 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 dev:web`: Start only the web application
|
|
- `bun run dev:server`: Start only the server
|
|
- `bun run check-types`: Check TypeScript types across all apps
|
|
- `bun run dev:native`: Start the React Native/Expo development server
|
|
- `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
|