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

Abierto Apto para principiantes
#159 1 comentario 0 reacciones 0 asignados Ver en GitHub

@Th-Shivam ya está trabajando en esto.

Desde el 30/9/2026.

  • #160 de @Th-Shivam — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
85/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
next.js, react, tailwindcss, typescript

Línea de trabajo

Actualiza frontend/README.md en lugar del README raíz o del backend. Primero inspecciona la configuración del frontend, los scripts, la estructura del proyecto, NEXT_PUBLIC_API_URL, la estructura en/hi de next-intl y el uso de shadcn; después reemplaza el texto de create-next-app por instrucciones específicas del proyecto. Se considera terminado cuando los nuevos contribuidores del frontend pueden instalar los prerrequisitos, configurar la URL de la API, ejecutar la aplicación, entender el layout y i18n, y usar componentes de shadcn.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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?

Lenguaje dominante
TypeScript
Estrellas
58
Forks
90
Merge medio
11 h 51 min
PR fusionados (30 d)
3

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de AOSSIE-Org/Perspective

Todos los issues de AOSSIE-Org/Perspective

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.