Skip to content

Commit f386323

Browse files
authored
Create a decent README (#30)
* chore: remove unused files * feat: noice readme
1 parent 8e6c901 commit f386323

File tree

9 files changed

+29
-280
lines changed

9 files changed

+29
-280
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
1+
# Personal Website & CV
2+
3+
Welcome! This repo is a showcase of modern web development, automation, and best practices. Here’s what makes it stand out:
4+
5+
## 🚀 Tech Stack
6+
- **Astro**: Lightning-fast static site generator for modern web apps
7+
- **Qwik**: Ultra-fast interactive components
8+
- **TypeScript**: Type-safe codebase for reliability
9+
- **Tailwind CSS**: Utility-first styling for rapid UI development
10+
- **Vitest**: Next-gen testing framework
11+
- **Puppeteer**: Automated PDF export of the CV
12+
13+
## 🛠️ Tooling
14+
- **pnpm**: Fast, disk-efficient package manager
15+
- **ESLint & Prettier**: Code quality and style enforcement
16+
- **Sharp**: Image processing for assets
17+
- **Custom Scripts**: Automated asset downloads and PDF generation
18+
- **Nix Flake**: Reproducible development environments via `flake.nix`.
19+
20+
## ⚙️ GitHub Actions
21+
- **Build & Deploy**: Automatic build and deployment on every push to `main`
22+
- **Release Automation**: Auto-create releases when bumping the website version
23+
- **PDF Generation**: CV is exported as a PDF and attached to releases
24+
- **Caching**: Speeds up CI with pnpm store caching
25+
- **Artifact Management**: Uploads and deploys both the website and CV
26+
27+
---
28+
See the workflows in `.github/workflows/` for more details on automation. Explore the code for best practices in TypeScript, Astro, and modern frontend engineering.
29+
130
# How does deployment work?
231
Every time there is push on `main` it will trigger the build pipeline and cache
332
the artifacts.

cvinformation-schema.json

Lines changed: 0 additions & 61 deletions
This file was deleted.

src/__test__/schemas/utils/zodToClass.test.ts

Lines changed: 0 additions & 43 deletions
This file was deleted.

src/schemas/CVInformation.ts

Lines changed: 0 additions & 39 deletions
This file was deleted.

src/schemas/Period.ts

Lines changed: 0 additions & 40 deletions
This file was deleted.

src/schemas/stringDateOrDate.ts

Lines changed: 0 additions & 7 deletions
This file was deleted.

src/schemas/utils/zodToClass.ts

Lines changed: 0 additions & 27 deletions
This file was deleted.

src/utils/getCVInformation.test.ts

Lines changed: 0 additions & 55 deletions
This file was deleted.

src/utils/getCVInformation.ts

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)