Overview
The Résumé theme repository is designed for the Json Résumé project. It provides an improved developer environment for editing themes easily. The project uses pnpm, vitejs, and vitest for its internal build processes and requires at least Node v16 to run. Users can use various commands for development, building, downloading, and previewing the résumé.
Features
- Developer Environment: The theme repository offers an improved developer environment for editing themes.
- PNPM: The project uses pnpm for efficient package management.
- Build Processes: The repository utilizes vitejs and vitest for all internal build processes.
- Quick Commands: Users can use various quick commands such as dev, build, build:pdf, download:resume, and serve for different tasks.
- Resume Creation: Users can create their own résumé.json file or use the provided resume-sample.json file.
- GitHub Integration: The theme supports GitHub integration for features like GitHub stars and downloading résumé from a GitHub gist.
- PDF Generation: Users can generate their résumé as a PDF by printing the web page or using the build:pdf command.
- Netlify Integration: Users can generate their résumé on Netlify by providing the required environment variables.
Installation
To install the Résumé theme, follow these steps:
- Clone the theme repository.
- Ensure Node v16 or above is installed on your system.
- Run the command
pnpm install to install the required dependencies. - Copy the
.env.dist file to .env.local. - Fill in the necessary environment variables in the
.env.local file, such as VITE_GITHUB_AUTH_TOKEN and VITE_GITHUB_RESUME_GIST_ID. - Start the development server by running
pnpm dev.
Summary
The Résumé theme repository provides an improved developer environment and convenient features for creating and editing résumés. Users can easily build their résumé using commands, generate PDF versions, and integrate with GitHub and Netlify for enhanced functionality. The installation process is straightforward, and the theme relies on popular tools like pnpm and vitejs for efficient development.