How charles5991/jikan-web works
Project type and purpose
• This is a front-end only single-page application (SPA) starter template built with React, TypeScript and Vite.
• It provides a boilerplate project with standardized folder structure, coding conventions (ESLint/Prettier), pre-commit hooks (Husky), TailwindCSS + shadcn/ui components, Vite plugins (SVG handling, auto-import, fonts), Docker support and Vercel deployment configuration.
File structure
• Top-level infra/config folders and files
• .github/ – Dependabot config
• Dockerfile, docker-compose.yml – container build/runtime
• .husky/, lintstagedrc.json – pre-commit linting & formatting
• eslint.config.js, .prettierrc.json, tsconfig.json – dev tool configs
• vercel.json – hosting deployment
• Public & static assets
• public/manifest.webmanifest, index.html, src/assets
• Source code under src/
• main.tsx → app entrypoint & Vite HMR server
• App.tsx → root component + router setup
• page/ → route-level pages (Home, AnimeDetails, NotFound)
• components/ → shared UI building blocks (buttons, cards, inputs)
• store/, hooks/, data/, utils/ → state management, custom hooks, API clients, helpers
• constants/, types/, configs/ → typing, theme and plugin configs
README for additional insights
• Confirms tech stack: React, TypeScript, Vite, Tailwind/shadcn-ui
• Highlights included plugins: vite-plugin-svgr, unplugin-fonts, unplugin-auto-import
• Suggests using Vercel (via vercel.json) for production SSR (though this template is client-only)
Detail is king
• Every folder or plugin that plays a role in build or runtime.
• Type generation and custom import aliases (@/components) in the config.
• Don’t overthink: break the project into infra/config, source code layers, runtime platform, and external services.