Skip to content

dakodonnell/astrolio

Repository files navigation

ASTROLIO: A one-page portfolio template

Netlify Status Astro Version GitHub stars GitHub forks GitHub issues GitHub PRs

🚀 Get Started

0. Ensure you have the proper dev tools:

  • For Astro to run on your system, you will also need to have Node.js installed, version v18.17.1 or v20.3.0 or later. (v19 is not supported.)
# Check if you already have a compatible version of Node.js installed
node -v
  • If the command returns a version number higher than v18.17.1 or v20.3.0 (excluding any v19), you’re good to go!

  • If the command returns an error message like Command 'node' not found, or a version number lower than the required, then you need to install a compatible Node.js version.

1. Use this repo as a template for an Astro project:

  • Using the command line:
# Initialize the project
npm create astro@latest -- --template dakodonnell/astrolio
  • Or, simply clone as a template from Github

2. Add your content:

Add your portfolio content:

  • Place your CV file as src/cv.json
  • Must follow the JSON Resume schema
  • Sample CV is included for demo or editing
  • Optional attributes for projects:
    "isActive": true,
    "GitHub": "https://github.com/GitHubUsername/GitHubRepo"
    
    

3. Launch the development server:

# See the result
npm run dev
  • Open http://localhost:4321 in your browser to see the result 🚀

  • If you wish to deploy your portfolio site to the web, continue to step 4

4. Push your portfolio to the web:

Connect your portfolio repo to a platform that deploys static web applications (Netlify or Vercel are good options)

  • If you know what you are doing, you can deploy your portfolio site directly from here:

Deploy to Netlify Deploy with Vercel

🪄 Command Palette

The Command Palette is a quick-access menu for portfolio actions, accessible via a hotkey on PC (Cmd+K / Ctrl+K) or a button on mobile.

Quickly use it to:

  • Export your portfolio as a PDF
  • Navigate to any project, publication, or website link from the resume
  • Jump to the Astrolio template page to create your own portfolio
Hotkeys match each action for instant access Command menu demo

🔑 License

MIT - Go crazy.

🫂 Special Thanks

About

A really good portfolio template for the Astro framework, using JSON resume. Lightweight, printable, plug and play. Features a hotkey command palette with quick links for bonus developer style points.

Topics

Resources

License

Stars

Watchers

Forks

Contributors