Initial human archive app
Some checks failed
Build and publish Docker image / docker (push) Failing after 2m33s
Some checks failed
Build and publish Docker image / docker (push) Failing after 2m33s
This commit is contained in:
66
README.md
66
README.md
@@ -1,36 +1,44 @@
|
||||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
||||
# Menschheits-Enzyklopaedie
|
||||
|
||||
## Getting Started
|
||||
Eine vorbereitete V1 fuer eine quellenpflichtige Wissensplattform mit KI-Frageportal, KI-Recherche, Community-Beitraegen und auditierbarer KI-Moderation.
|
||||
|
||||
First, run the development server:
|
||||
## Stack
|
||||
|
||||
- Next.js App Router mit TypeScript und Tailwind CSS
|
||||
- Postgres mit Prisma
|
||||
- NextAuth Credentials-Grundlage fuer spaetere Rollen-Logins
|
||||
- LiteLLM-kompatible LLM-Schicht fuer lokale und externe Modelle
|
||||
- Vitest fuer fokussierte Service-Tests
|
||||
|
||||
## Lokale Einrichtung
|
||||
|
||||
1. `.env.example` nach `.env` kopieren und Werte setzen.
|
||||
2. Postgres starten, zum Beispiel mit `docker compose -f docker-compose.example.yml up postgres`.
|
||||
3. Prisma Client generieren: `npm run prisma:generate`.
|
||||
4. Migrationen fuer die Entwicklung ausfuehren: `npm run db:dev`.
|
||||
5. App starten: `npm run dev`.
|
||||
|
||||
## Wichtige Routen
|
||||
|
||||
- `/` - Frageportal und KI-Recherche
|
||||
- `/admin` - Admin Center fuer KI-Moderationsentscheidungen
|
||||
- `/api/health` - Health Check fuer App und Datenbank
|
||||
- `/api/questions` - quellenbasierte KI-Antworten
|
||||
- `/api/research` - KI-Recherche mit Quellenpflicht und Moderation
|
||||
- `/api/contributions` - Community-Beitraege
|
||||
|
||||
## Docker-Vorbereitung
|
||||
|
||||
Das Repository enthaelt ein Dockerfile und `.dockerignore`, aber noch keinen Release- oder Publish-Prozess. Das Image erwartet Runtime-Konfiguration ueber Umgebungsvariablen und fuehrt keine destruktiven Migrationen beim Start aus.
|
||||
|
||||
Produktionsnaher Build:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
docker build -t human-archive:local .
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
## Entwicklungshinweise
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
||||
|
||||
## Deploy on Vercel
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
||||
- Ohne `LITELLM_BASE_URL` und `LITELLM_API_KEY` nutzt die App einen lokalen Fallback, damit Builds und UI-Flows nicht an fehlenden Modellzugangsdaten scheitern.
|
||||
- Die API akzeptiert in `NODE_ENV !== "production"` den Header `x-demo-role: MEMBER` oder `x-demo-role: ADMIN`, um Workflows ohne eingerichtetes Login zu testen.
|
||||
- Kein veroeffentlichter Wissenseintrag darf ohne gespeicherte Quelle entstehen.
|
||||
|
||||
Reference in New Issue
Block a user