simple-resume-site

A fast, responsive, SEO-friendly single‑page resume website template powered by React, TypeScript, Tailwind CSS, Vite, and Static Site Generation.

Demo

• Live demo: https://wei.github.io/simple-resume-site
• Screenshot:

Features

• React + TypeScript responsive single‑page web app
• Content is driven by a single JSON file for easy customization
• Static Site Generation (SSG) for fast first paint and SEO
• GitHub Actions for CI and GitHub Pages deployment
• Formatter & linter with pre‑commit hooks

Getting Started

1. Make a new repo from this template
2. Content: edit site-data.json
3. Profile image: replace public/profile.jpeg with your own profile image (200×200 recommended)

Generate site-data.json from LinkedIn using AI

1. LinkedIn Profile → More → Save as PDF
2. Download site-data.json
3. Upload both files to your favorite AI and ask it to generate a site-data.json file tailored to you!

Deployment

GitHub Pages

1. Ensure the repository has Pages enabled under Settings → Pages, with source “GitHub Actions”.
2. The included workflow .github/workflows/deploy.yml builds and deploys on pushes to main.
3. Push to main. The site will publish to the Pages URL shown in the workflow output.
4. Optionally, set up a custom domain under Settings → Pages.

Other static site hosting

• Vercel, Netlify, Cloudflare Pages: configure a project that runs npm run build and serves the dist/ directory.

Project Structure

• index.html: main html file
• src/: react components and app entry
• public/: static assets like profile image
• site-data.json: all content for the site
• dist/: generated site output (not committed)

Scripts

• npm run dev: start local dev server
• npm run build: build static site with SSG
• npm run preview: preview built output
• npm run lint: check formatting/lint with Biome
• npm run lint:fix: auto‑format and fix with Biome

Contribution

See CONTRIBUTING.md

License

MIT