https://github.com/wei/simple-resume-site

A fast, responsive, SEO-friendly single‑page resume website template powered by React, TypeScript, Tailwind CSS, Vite, and Static Site Generation.
https://github.com/wei/simple-resume-site

resume resume-site resume-website website-template

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/wei/simple-resume-site
• Owner: wei
• Created: 2025-09-02T05:04:19.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2025-09-02T06:30:54.000Z (5 months ago)
• Last Synced: 2025-09-02T07:19:32.027Z (5 months ago)
• Topics: resume, resume-site, resume-website, website-template
• Language: TypeScript
• Homepage: https://wei.github.io/simple-resume-site/
• Size: 66.4 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

          
# simple-resume-site

[![CI](https://img.shields.io/github/actions/workflow/status/wei/simple-resume/ci.yml?branch=main&label=CI)](https://github.com/wei/simple-resume/actions/workflows/ci.yml)

[![Deploy](https://img.shields.io/github/actions/workflow/status/wei/simple-resume/deploy.yml?branch=main&label=Deploy)](https://github.com/wei/simple-resume/actions/workflows/deploy.yml)

[![Code Style: Biome](https://img.shields.io/badge/code%20style-biome-70a3f3)](https://biomejs.dev)

[![Node 24](https://img.shields.io/badge/node-24.x-339933?logo=node.js&logoColor=white)](.nvmrc)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://wei.mit-license.org/)

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: ![screenshot](https://github.com/user-attachments/assets/4bcf0596-3e41-4552-967f-c43c0bbc0a79)

## 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](https://github.com/new?template_name=simple-resume&template_owner=wei)

3. Content: edit `site-data.json`

4. 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](./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](CONTRIBUTING.md)

## License

[MIT](https://wei.mit-license.org/)