mirror of
https://github.com/ershisan99/mlb-overlay-server.git
synced 2025-12-16 20:59:25 +00:00
initial commit
This commit is contained in:
66
README.md
Normal file
66
README.md
Normal file
@@ -0,0 +1,66 @@
|
||||
# mlb-overlay-server
|
||||
|
||||
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, TRPC, and more.
|
||||
|
||||
## Features
|
||||
|
||||
- **TypeScript** - For type safety and improved developer experience
|
||||
- **TanStack Router** - File-based routing with full type safety
|
||||
- **TailwindCSS** - Utility-first CSS for rapid UI development
|
||||
- **shadcn/ui** - Reusable UI components
|
||||
- **Hono** - Lightweight, performant server framework
|
||||
- **tRPC** - End-to-end type-safe APIs
|
||||
- **Bun** - Runtime environment
|
||||
- **Drizzle** - TypeScript-first ORM
|
||||
- **PostgreSQL** - Database engine
|
||||
- **Authentication** - Email & password authentication with Better Auth
|
||||
|
||||
## 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 db:push
|
||||
```
|
||||
|
||||
|
||||
Then, run the development server:
|
||||
|
||||
```bash
|
||||
bun dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3001](http://localhost:3001) in your browser to see the web application.
|
||||
The API is running at [http://localhost:3000](http://localhost:3000).
|
||||
|
||||
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
mlb-overlay-server/
|
||||
├── apps/
|
||||
│ ├── web/ # Frontend application (React + TanStack Router)
|
||||
│ └── server/ # Backend API (Hono, TRPC)
|
||||
```
|
||||
|
||||
## Available Scripts
|
||||
|
||||
- `bun dev`: Start all applications in development mode
|
||||
- `bun build`: Build all applications
|
||||
- `bun dev:web`: Start only the web application
|
||||
- `bun dev:server`: Start only the server
|
||||
- `bun check-types`: Check TypeScript types across all apps
|
||||
- `bun db:push`: Push schema changes to database
|
||||
- `bun db:studio`: Open database studio UI
|
||||
Reference in New Issue
Block a user