joachim/me-joachimhummel-de
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update project setup and remove unnecessary database requirements

Browse Source 
Refactor README.md to remove database prerequisites and environmental variables, as the API server does not utilize the database.

Replit-Commit-Author: Agent
Replit-Commit-Session-Id: 6f3329ae-2dcc-46cc-bf2e-f58b7a5fa805
Replit-Commit-Checkpoint-Type: full_checkpoint
Replit-Commit-Event-Id: 9e23be68-a2a3-473e-9d7c-be900f23a459
Replit-Commit-Screenshot-Url: https://storage.googleapis.com/screenshot-production-us-central1/e678fe28-87ab-4437-945b-7a15e872a292/6f3329ae-2dcc-46cc-bf2e-f58b7a5fa805/vRxTy2Z
Replit-Helium-Checkpoint-Created: true
This commit is contained in:
joachimhummel
2026-05-15 16:43:58 +00:00
parent 5be049e5b4
commit 5fb91deb13
1 changed files with 1 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -10,7 +10,6 @@ Built with React + Vite (frontend) and Express 5 (API), running as a pnpm monore
- **Node.js** 24+ - **Node.js** 24+
- **pnpm** 10+ — install via `npm install -g pnpm` - **pnpm** 10+ — install via `npm install -g pnpm`
- **PostgreSQL** 14+ — local installation or a hosted instance (e.g. Supabase, Neon, Railway)
--- ---
@@ -32,9 +31,6 @@ pnpm install
Create a `.env` file in the project root (or export the variables in your shell): Create a `.env` file in the project root (or export the variables in your shell):
```env ```env
# PostgreSQL connection string (required)
DATABASE_URL=postgresql://user:password@localhost:5432/portfolio
# Session secret — any long random string (required) # Session secret — any long random string (required)
SESSION_SECRET=your-very-long-random-secret-here SESSION_SECRET=your-very-long-random-secret-here
@@ -46,16 +42,6 @@ BREVO_API_KEY=your-brevo-api-key
--- ---
## Database Setup
Push the schema to your PostgreSQL database (run once, or after schema changes):
```bash
pnpm --filter @workspace/db run push
```
---
## Running Locally ## Running Locally
Start both services in separate terminal windows: Start both services in separate terminal windows:
@@ -76,10 +62,9 @@ Open **http://localhost:23924** in your browser.
``` ```
artifacts/ artifacts/
api-server/ # Express 5 API — contact form, health check api-server/ # Express 5 API — contact form, email via Brevo
joachim-portfolio/ # React + Vite frontend (portfolio site) joachim-portfolio/ # React + Vite frontend (portfolio site)
lib/ lib/
db/ # Drizzle ORM schema & migrations
api-spec/ # OpenAPI spec + generated client hooks api-spec/ # OpenAPI spec + generated client hooks
api-client-react/ # Generated React Query hooks (from Orval) api-client-react/ # Generated React Query hooks (from Orval)
scripts/ # Utility scripts scripts/ # Utility scripts
@@ -94,7 +79,6 @@ scripts/ # Utility scripts
| `pnpm install` | Install all dependencies | | `pnpm install` | Install all dependencies |
| `pnpm run typecheck` | Full TypeScript check across all packages | | `pnpm run typecheck` | Full TypeScript check across all packages |
| `pnpm run build` | Typecheck + build all packages | | `pnpm run build` | Typecheck + build all packages |
| `pnpm --filter @workspace/db run push` | Push DB schema changes (dev only) |
| `pnpm --filter @workspace/api-spec run codegen` | Regenerate API hooks from OpenAPI spec | | `pnpm --filter @workspace/api-spec run codegen` | Regenerate API hooks from OpenAPI spec |
--- ---