Skip to content

Smilesharks/dev-portfolio

 
 

Repository files navigation

Print-friendly portfolio CV

preview

Astro Badge TailwindCSS GitHub stars GitHub issues GitHub forks GitHub PRs

✨ Features

  • Print-friendly - Optimised layout for PDF export and printing
  • Dark/Light mode - System preference detection with manual override
  • 5 Colour themes - Default, blue, red, green, and cyber themes
  • Keyboard shortcuts - Command palette with Cmd/Ctrl + K
  • Responsive design - Mobile-first approach with Tailwind CSS 4
  • JSON-based content - Easy content management via cv.json

🛠️ Stack

  • Astro - The next-gen web framework.
  • Tailwind CSS 4 - A utility-first CSS framework with CSS-first configuration.
  • Alpine.js - Lightweight JavaScript framework for composing behaviour.
  • Typescript - JavaScript with type syntax.
  • HotKeyPad - Command palette with keyboard shortcuts.

🚀 Getting Started

1. Use this Repo as an Astro Project Template

  • I use pnpm as my package manager.
# Enable pnpm on MacOS, WSL & Linux:
corepack enable
corepack prepare pnpm@latest --activate

Initialize the project

pnpm create astro@latest -- --template Smilesharks/dev-portfolio

2. Add Your Content:

Edit the cv.json file to create your own printable Portfolio/CV.

3. Launch the Development Server:

# Enjoy the results
pnpm dev
  1. Open http://localhost:4321 in your browser to view the result 🚀

4. Customisable colours:

Change the theme property in cv.json and choose one of the available colour themes:

Theme Description
default Orange accent (default)
blue Blue/slate accent
red Red/stone accent
green Lime/green accent
cyber Yellow/cyan cyberpunk style

Each theme includes light and dark mode variants. The theme selector dropdown allows users to switch between light, dark, and system preference.

Creating custom themes:

Edit src/styles/global.css and add your theme variables under the appropriate selectors (:root [data-theme="your-theme"] for light mode, .dark [data-theme="your-theme"] for dark mode).

🧞 Commands

Command Action
⚙️ dev o start Launches a local development server at localhost:4321.
⚙️ build Checks for errors and creates a production build in ./dist/.
⚙️ preview Local preview at localhost:4321

Wiki: dev-portfolio

CV JSON schema from jsonresume.org

Based on Bartosz Jarocki - Print-friendly, minimalist CV page and Miguel Ángel Durán - minimalist-portfolio-json

About

A minimalist portfolio configurable via one JSON

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Astro 92.7%
  • CSS 7.0%
  • JavaScript 0.3%