tperich / curriculum-vitae

A modern and interactive web-based Curriculum Vitae built with React, TypeScript, and Vite

Curriculum Vitae

+ + =

A modern and interactive web-based Curriculum Vitae built with React, TypeScript, and Vite.

Features • Getting Started

Features

• React for building reusable UI components
• TypeScript for type safety and better developer experience
• Vite for fast development and efficient production build
• Docker for easy deployment and containerization
• Nginx for serving production build

Getting Started

Prerequisites

• Node.js >= 14.x
• Docker and Docker Compose (optional, for development or deployment)

Installation

1. Clone the repository:

git clone https://github.com/tperich/curriculum-vitae.git

2. Install dependencies

npm install

3. Copy .env.example to .env and fill out your desired information

4. Edit files in src/data/ for work experience and skills

Development

To start the development server, run:

npm run dev

The application will be available at http://localhost:5173.

Production

To build the production version, run:

npm run build

The production build will be located in the dist/ folder.

Deployment

For development deployment using Docker, run:

sudo docker compose up

For production deployment using Docker, run:

docker-compose -f docker-compose.prod.yml up

Available npm/yarn scripts

Command	Explanation
npm run dev	Starts the development server on localhost:5173
npm run build	Builds the project using Vite

License

This project is licensed under BSD 2-Clause License

curriculum-vitae's Issues

Fix PDF export

Currently PDF exporting doesn't work as expected due to the page being offset.

Determine a way to export CV as PDF regardless of screen size.

Implement secrets for personal information

Find a way, whether using an .env file, YML config, or Ansible Vault (possibly), to avoid hard-coding personal information such as email, phone number, website, location, etc.