Files
ai-resume/README.md

66 lines
2.3 KiB
Markdown

# AI Resume
**An AI-powered resume and career showcase — a terminal-inspired interface that lets recruiters ask questions and get answers about my work.**
A React application that presents a resume through an interactive, terminal-flavored interface. Features Markdown rendering, syntax highlighting, and a terminal emulator (`xterm`) — designed to demonstrate both front-end craft and AI integration for employment outreach.
## What it is
A showcase site where my professional story is told through an interactive AI experience. Instead of a static PDF, recruiters engage with a terminal-style interface backed by AI — asking questions about experience, skills, and projects, and receiving answers rendered as rich Markdown.
## Tech stack
| Layer | Technology |
|-------|-----------|
| Framework | React 19 |
| Build | Vite 6 |
| Terminal UI | xterm (`@xterm/xterm`) |
| Markdown | react-markdown |
| Syntax highlighting | prismjs |
| Language | TypeScript |
## Architecture & design patterns
- **Terminal-driven UX** — `xterm` provides the interactive terminal canvas
- **Markdown pipeline** — AI responses rendered through `react-markdown` + prismjs syntax highlighting for code blocks
- **Componentized** — `App.tsx` orchestrates the hero, framework, and terminal views
- **Vite HMR** — fast development with hot module replacement
- **Static + dynamic blend** — static showcase content augmented by the live AI interface
## Standards
- TypeScript
- Semantic HTML
- Vite production build (`tsc -b && vite build`)
- ESLint for code quality
## Getting started
```bash
npm install
npm run dev # development server
npm run build # production build
npm run lint # lint
```
## Structure
```
src/
├── assets/ # Images (hero, framework logos)
├── App.tsx # Main application shell
├── App.css # Styling
├── index.css # Global styles
└── main.tsx # Entry point
```
## Roadmap
- [ ] Wire the terminal to the AI resume backend (see `aboutme_chat` — the LangChain/RAG service)
- [ ] Embed AI Q&A about experience, skills, and projects
- [ ] Add project gallery with syntax-highlighted code samples
---
*The front-end of the AI resume system. Backend services (LangChain/RAG chat) live in [aboutme_chat](https://gitea.lab.audasmedia.com.au/sam/aboutme_chat). Part of the Sam Rolfe portfolio family.*