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

Đang mở Phù hợp với người mới
#159 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

@Th-Shivam đang làm issue này rồi.

Từ ngày 30/9/2026.

  • #160 của @Th-Shivam — đang mở

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
85/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
next.js, react, tailwindcss, typescript

Hướng nghiên cứu

Cập nhật frontend/README.md thay vì README ở root hoặc backend. Trước tiên, hãy kiểm tra thiết lập frontend, các script, bố cục dự án, NEXT_PUBLIC_API_URL, cấu trúc en/hi của next-intl và cách sử dụng shadcn, sau đó thay thế nội dung của create-next-app bằng hướng dẫn dành riêng cho dự án. Công việc được xem là hoàn tất khi những người đóng góp frontend mới có thể cài đặt các điều kiện tiên quyết, cấu hình URL API, chạy ứng dụng, hiểu bố cục và i18n, cũng như sử dụng các component shadcn.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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?

Ngôn ngữ chính
TypeScript
Star
58
Fork
90
Merge trung bình
11 giờ 51 phút
Pull request đã merge (30 ngày)
3

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của AOSSIE-Org/Perspective

Tất cả issue của AOSSIE-Org/Perspective

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.