stefan-yas / aesthetic-resume

Make beautiful resumes using Astro, Markdown and Puppeteer.

Aesthetic Resume

Make beautiful resumes using Astro, Markdown and Puppeteer.

Usage

git clone https://github.com/stefan-yas/aesthetic-resume.git
cd aesthetic-resume
npm i
npm run dev

Once you've installed the project dependencies and started the dev server, go into the src/pages folder and edit the .md files inside the contact, education, image, jobs and skills folders.

Once you've edited your resume, go back to the terminal and type node downloadAsPdf.js. The script will download a .pdf of your resume in the project's root folder, titled resume.pdf.

Project Structure

Inside of this project, you'll see the following folders and files:

/
├── public/
│   └── capture.png
│   └── favicon.svg
│   └── piedpiper.png
├── src/
│   └── components/
│       └── themeSwitcher.astro
│   └── layouts/
│       └── contactLayout.astro
│       └── educationLayout.astro
│       └── imageLayout.astro
│       └── jobsLayout.astro
│       └── projectsLayout.astro
│       └── sectionLayout.astro
│       └── skillsLayout.astro
│   └── pages/
│       └── contact/
│           └── contact.md
│       └── education/
│           └── uni.md
│       └── image/
│           └── signature.md
│       └── jobs/
│           └── 1-hooli.md
│           └── 2-piedpiper.md
│       └── projects/
│           └── piedpiper_copy_copy.md
│           └── piperchat_copy.md
│           └── piedpiper.md
│           └── piperchat.md
│       └── skills/
│           └── 1-leadership.md
│           └── 2-programming.md
│           └── web3.md
│       └── index.astro
│   └── styles/
│       └── global.css
└── downloadAsPdf.js
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory.

Commands

All commands are run from the root of the project, from a terminal:

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:3000
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run astro ...	Run CLI commands like astro add, astro check
npm run astro --help	Get help using the Astro CLI
npm run format	Formats all code using Prettier

To-do

• Order work experience automatically by date 🌑
• Projects section 🌕
• Option for custom links in the contact section 🌑
• Theme support 🌓
• Server-side resume creation, so the user doesn't have to use the command-line 🌑