This is the theme repository for the Json Résumé project. Unlike the json-theme-boilerplate project, this environment has a much improved developer environment to make editing your theme super to do.
Daniel Bannert's open source work is supported by the community on GitHub Sponsors
This project uses pnpm, vitejs and vitest for all its internal build processes. In theory, this project requires at lest Node v18 to run.
pnpm run dev
- Run the build and generate an résumé html page for developmentpnpm run build
- Builds the résumé into ahtml
filepnpm run build:pdf
- Builds the résumé into apdf
file (requirespnpm run build
to be called first)pnpm run download:resume
- Download your gist resume.json (and resume.private.jons)pnpm run serve
- Locally preview the production build
This project comes with resume-sample.json
, which is a sample json résumé you can build from. If you don’t create a resume.json
file, it will automatically be created against the resume-sample.json
file.
It’s highly recommended to create your own resume.json
for your own résumé. If you create a resume.json
, this will automatically be used by the app instead. The resume.private.json
file is automatically ignored from GIT to ensure you cannot check it in (since you’ll have personal information on there). If you do decide that you want to check it in, you can comment the following line in .gitignore
like so:
# Keep your personal resume.json private
# resume.json
# resume.private.json
Please review the schema here when creating your resume.json
.
- Copy the
.env.dist
to.env.local
- To make use of the
GitHub stars
feature, fill theVITE_GITHUB_AUTH_TOKEN
variable with yourGitHub auth_token
, to not run into GitHub’s API limitation - To use the
pnpm run download:resume
command, fill theVITE_GITHUB_RESUME_GIST_ID
variable with yourgist id
- Start the dev server (
pnpm run dev
)
To generate an résumé locally:
- Copy the
.env.dist
to.env.local
- To make use of the
GitHub stars
feature, fill theVITE_GITHUB_AUTH_TOKEN
variable, to not run into GitHub’s API limitation - Start the dev server (
pnpm run dev
) - Print the web page (⌘/Ctrl P) as a PDF In fact, this Is exactly how the PDF is generated by the pipeline. Since the pipeline uses headless Chrome, printing the résumé locally using Chrome will provide the most consistent result.
- Or you can use the
pnpm run build:pdf"
command, but before you can use this command you need to callpnpm run build
- To check the build résumé, call
pnpm run serve
- Provide the env variables
VITE_GITHUB_AUTH_TOKEN
to not get theGitHub
API limit - Option if you like to download the résumé from a
GitHub
gist, provide theVITE_GITHUB_RESUME_GIST_ID
with yourgist id
netlify.toml
:
[build]
# If you download your resume.json (and resume.private.json) from a gist please use the command below and uncomment the current command
# command = "pnpm run download:resume && pnpm run build && pnpm run build:pdf"
command = "pnpm run build && pnpm run build:pdf"
publish = "dist"
[build.environment]
NODE_VERSION = "18"
The pipeline generates a PDF using the public information found in
resume.json
and does not include any private data
specified in resume.private.json
. (For example, phone numbers.)
Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.
If you would like to help take a look at the list of issues and check our Contributing guild.
Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
The anolilab résumé is open-sourced software licensed under the MIT license