docs: frontend/README.md is the default create-next-app boilerplate

Aperta Adatta ai principianti
#159 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

@Th-Shivam ci sta già lavorando.

Dal 30/9/2026.

  • #160 di @Th-Shivam — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
85/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
next.js, react, tailwindcss, typescript

Direzione di ricerca

Aggiorna frontend/README.md invece del README nella root o nel backend. Prima esamina la configurazione del frontend, gli script, la struttura del progetto, NEXT_PUBLIC_API_URL, la struttura en/hi di next-intl e l'uso di shadcn, quindi sostituisci il testo di create-next-app con istruzioni specifiche per il progetto. Il lavoro è completato quando i nuovi contributori del frontend possono installare i prerequisiti, configurare l'URL dell'API, eseguire l'applicazione, comprendere la struttura e i18n e usare i componenti shadcn.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Problem

frontend/README.md is still the default create-next-app template. It has only
generic Next.js content (Getting Started with app/page.tsx, next/font/Geist,
"Deploy on Vercel") and nothing specific to Perspective — no actual stack, no local
setup, no NEXT_PUBLIC_API_URL, no next-intl (en/hi) i18n structure, no project
layout. It's misleading for new frontend contributors (e.g. it points to Vercel,
while this project deploys the backend to Hugging Face).

Relation to existing work

Distinct from #126 and PR #132, which cover the root README, the backend
README, and .env.example files — neither touches frontend/README.md.

Proposed fix

Replace the boilerplate with frontend-specific docs: tech stack (Next.js 15 App
Router, React 19, TS, Tailwind + shadcn/ui, next-intl), prerequisites + setup,
NEXT_PUBLIC_API_URL, npm scripts, i18n structure (en/hi), project layout, shadcn usage.

I'd like to work on this — could it be assigned to me?

Lingua principale
TypeScript
Stelle
58
Fork
90
Merge medio
11h 51m
PR unite (30g)
3

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di AOSSIE-Org/Perspective

Tutte le issue di AOSSIE-Org/Perspective

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.