0.0.1 • Published 3 months ago

@zoobzio/nuxt-resume-layer v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
3 months ago

Nuxt Resume Layer

nuxt-resume-layer is a Nuxt application layer that allows a developer to quickly create an extensible digital resume using a fully-featured implementation of Nuxt.

Getting Started

To get started building your resume, first install the layer in your Nuxt project:

# add as dev dependency
pnpm add -D @zoobzio/nuxt-resume-layer

Then you will need to extend your Nuxt application using the nuxt.config file:

// nuxt.config.ts
export default defineNuxtConfig({
    extends: ["@zoobzio/nuxt-resume-layer"],
});

Your resume is almost ready! We only need to populate the app.config.ts with your details to provide content:

// app.config.ts
export default defineAppConfig({
  avatar: "/avatar.svg",
  name: "Your Name Here",
  title: "Developer",
  bio: "I work and do things! Lets work together!",
  githubUser: "zoobzio",
  links: [],
  socialLinks: [],
  career: [],
  education: [],
  certifications: [],
  skills: [],
});

You can find a full example of a possible configuration in ~/.playground/src/app.config.ts.

Tools

nuxt-resume-layer is built on top of a foundation layer that provides a complete developer toolset that is available for use in your resume, including:

Customization

Once you have a Nuxt application using the resume layer, you can extend the application using drop-in replacements. Don't like the career card? Simply add a new component in your base layer under ~/components/resume/career.vue and Nuxt will take care of the rest!

You can even drop a replacement page component at ~/pages/index.vue to build your own resume page using the components made available in this project or your own custom components.

Documentation

Coming soon!

Development

Start the development server on http://localhost:3000:

# install deps 
pnpm i

# run dev server
pnpm dev

Development on this project will use the example configuration in ~/.playground. Have fun!

Todo

  • Write tests for 100% coverage