Ashesi CV Builder

An intuitive CV builder for Ashesi University students

Explore Docs . Report Bug · Request Feature

Table of Content

• About The Project
  • Overview
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Features
• Contributing
• Contact
• Acknowledgments

About The Project

Overview

Idea

Ashesi-specific CV builder to stop combatting the error-prone MS Word template file

Industry Comparison

Existing Services: Flow CV, Zety, Resume.io, cvmaker

Discoveries and Observations:

• Often encourages the inclusion of a professional summary, which Ashesi does not give space for in its template
• Live CV preview is a common feature
• Most only allow entry of one phone number
• Most allow the addition of links such as GitHub, LinkedIn, etc.

UI Design

Figma file: https://www.figma.com/file/pk2nLD0cpkspC1QRtvEoIO/CV-Builder?type=design&node-id=0%3A1&mode=design&t=fN2sGtXDXIk357ZB-1

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

• Node.js
• Node Package Manager (NPM)

Installation

1. Clone the repo

   git clone https://github.com/chinweibegbu/ashesi-cv-builder.git

2. Install NPM packages

   npm install

3. Start local environment

   npm run start

(back to top)

Contributing

If you have a suggestion that would make this better, follow these steps:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/NewFeature)
3. Commit your Changes (git commit -m 'Add some NewFeature')
4. Push to the Branch (git push origin feature/NewFeature)
5. Open a Pull Request

Alternatively, you can open an Issue.

(back to top)

Features

Landing Page

• Sign in
• Sign up

Homepage

• View all created CVs
• Create new CV
• Edit existing CV

Create New CV Page

• Live CV preview
• Add details to profile:
  • Full name
  • Current city and country
  • Phone number
  • Email address
  • Nationality
  • LinkedIn
  • Any other websites (e.g. GitHub, WordPress, personal website, etc.)
• Add details to sections:
  • Education
    • Name of institution
    • Degree
    • Name of degree
    • Location (City, Country)
    • Start and end dates
    • Cumulative GPA*
  • Achievements/Awards
    • Achievement/Award name
    • Associated institution
    • Date acquired (one-time)/Start and end dates (continuous)
  • Work Experience
    • Name of institution
    • Location of company
    • Position
    • Start and end dates
    • Description
  • Skills
    • Soft skills
    • Hard skills
  • References
  • Projects/Research*
  • Co-curricular*
  • Interests*
  • Publications*
• Definitions of terms
• Download CV
• Get link to CV
• Email CV to user

* - optional fields

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Chinwe Ibegbu - chinwe.ibegbu@gmail.com

Project Link: https://github.com/chinweibegbu/ashesi-cv-builder/

(back to top)

Acknowledgments

• README.md template by Drew Othneil
• Awesome Badges by Vedant Chainani
• Markdown Badges by Ileriayo Adebiyi

(back to top)