Skip to content

neilmcgu/resume-api-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Resume as a Website and API

Resume as a Website is an API that helps you display your resume as a website.

Demo

Preview gif of the example resume

Live Preview

Live Preview

Tech Stack

HTML, CSS, JavaScript, Node.js, Express, EJS

API Reference

Get all resume fields

  GET /resume

Get contact

  GET /contact

Get education

  GET /education

Get experience

  GET /experience

Get projects

  GET /projects

Get skills

  GET /skills

Get socials

  GET /socials

Run Locally

Clone the project

  git clone https://github.com/neilmcgu/resume-api-template.git

Go to the project directory

  cd resume-api-template

Install dependencies

  npm install

Start the server

  node server.js

Usage/Examples

Navigate to the main.js file which can be found in ./public/assets/js

Find the instantiated object, shown below, and edit all the values to your personal deletes.

const resume = new Resume();

resume.name = "Bob Coder";
resume.title = "Software Engineer";
resume.email = "bob@coder.com";
resume.phone = 6105555555;
resume.education = [
  {
    school: "University of Pennsylvania",
    location: "Philadelphia, PA",
    degree: "Bachelor of Arts",
    major: "Economics",
    startDate: "2014-09-01",
    endDate: "2018-05-01",
  },
];
resume.summary =
  "Creative, detail-oriented, software engineer with a deep interest in AI. Proven track record of creating and implementing successful front and back end web applications. Looking to bring my skills to a tech company with global reach.";

...
...
...
...

Roadmap

  • Improvement in style to match a standard resume format and improve readability
  • Exception handling for missing fields
  • Form integration so users can upload their resume file or form addition with input fields for each field that will then generate the resume page for the user
  • Add about section

Lessons Learned

When building out an API you can really go wild with the routes and include one for every piece of information

License

MIT

About

Display a resume as a website and allow the information to be accessed as an API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors