Skip to content

Latest commit

 

History

History
143 lines (100 loc) · 3.61 KB

README.md

File metadata and controls

143 lines (100 loc) · 3.61 KB

English Documentation · 中文文档

@ying-web/www 📄

A modern resume website built with Next.js 15 and React 19, featuring SSG/SSR rendering and multi-language support.

Overview 🌟

This resume website is part of the @ying-web ecosystem, built with Next.js 15 and TypeScript. It provides a clean and elegant interface for showcasing professional experience, skills, and projects.

Tech Stack 💻

  • ⚛️ React 19 - Modern UI development
  • 📘 TypeScript - Type-safe development
  • 🔄 Next.js 15 - React framework with SSR/SSG support
  • 🎨 Tailwind CSS - Utility-first CSS
  • 🌙 next-themes - Dark mode support
  • 🔍 SEO Optimized - Better search visibility

Prerequisites 📋

  • Node.js >= 18.16.0
  • PNPM: 8.15.8 or 9.14.2

Local Development 💻

  1. Install dependencies:
pnpm install
  1. Configure environment:
# Copy environment file
cp .env.example .env

# Configure your environment variables
NEXT_PUBLIC_SITE_NAME="Ying Web"
NEXT_PUBLIC_SITE_COPYRIGHT="krissarea"
NEXT_DEFAULT_METADATA_DEFAULT_TITLE="Ying Web - Modern Web Development"
NEXT_PUBLIC_SITE_DESCRIPTION="A modern web development platform with React, Next.js, and TypeScript."
NEXT_PUBLIC_BASE_URL="https://www.krissarea.com" # my main site
  1. Start development server:
# Start with hot reload (port 3000)
pnpm dev

# Run linting
pnpm lint

# Run linting for all files
pnpm lint:all

# Run style linting
pnpm stylelint

# Run style linting with auto-fix
pnpm stylelint:fix

Production Deployment 🚀

Vercel Deployment (Recommended) ▲

This project is optimized for Vercel deployment.

  1. Connect your GitHub repository to Vercel

  2. Configure the following settings:

    • Framework Preset: Next.js
    • Build Command: pnpm build
    • Output Directory: .next
    • Install Command: pnpm install

  3. Add environment variables in Vercel project settings:

NEXT_PUBLIC_SITE_NAME="Ying Web"
NEXT_PUBLIC_SITE_COPYRIGHT="krissarea"
NEXT_DEFAULT_METADATA_DEFAULT_TITLE="Ying Web - Modern Web Development"
NEXT_PUBLIC_SITE_DESCRIPTION="A modern web development platform with React, Next.js, and TypeScript."
NEXT_PUBLIC_BASE_URL="https://www.krissarea.com"
  1. Deploy! Vercel will automatically handle the build and deployment process.

Manual Deployment

  1. Build for production:
# Build the application
pnpm build

# Start production server
pnpm start

Project Structure 📁

apps/www/
├── src/                # Source code
│   ├── app/           # Next.js app directory
│   │   ├── api/       # API routes
│   │   └── page.tsx   # Main page
│   ├── components/    # Reusable components
│   ├── hooks/         # Custom React hooks
│   ├── lib/           # Utility functions
│   ├── styles/        # Global styles
│   └── types/         # TypeScript types
└── public/            # Static files

Environment Variables 🔧

Required variables in .env:

# Site Configuration
NEXT_PUBLIC_SITE_NAME="Ying Web"
NEXT_PUBLIC_SITE_COPYRIGHT="krissarea"
NEXT_DEFAULT_METADATA_DEFAULT_TITLE="Ying Web - Modern Web Development"
NEXT_PUBLIC_SITE_DESCRIPTION="A modern web development platform with React, Next.js, and TypeScript."
NEXT_PUBLIC_BASE_URL="https://www.krissarea.com"

License 📄

MIT License - see the LICENSE file for details.

Author ✨

Kris - Website - Email

Made with ❤️ by the @ying-web