Code Monkey home page Code Monkey logo

insta-cv's Introduction

InstaCV

AI Powered Resume Builder

CodePath WEB103 Final Project

Designed and developed by: James Bustos

Link to deployed app: https://wwwinstacv.jamesjbustos.com/

resume-ui

Table of Contents

About

Description and Purpose

InstaCV, an AI-powered resume builder, seeks to reinvent the resume creation process. Using the capabilities of OpenAI's GPT and Whisper APIs, InstaCV offers users the flexibility to either narrate their professional journey or input their experiences manually. In either scenario, the platform employs AI to analyze, structure, and optimize the content into a polished, professional resume tailored to target roles. By providing this dual approach, InstaCV addresses the challenges many face in drafting impactful resumes and ensures a tailored, high-quality output.

Inspiration

The idea of InstaCV arose from the often tedious and restrictive nature of traditional resume crafting. Recognizing the challenges faced during job applications โ€“ from constant revisions to impersonal templates โ€“ InstaCV was conceptualized to offer a seamless and personalized resume-building experience. The platform empowers users to convey their career narratives and have them adeptly translated into resumes that encapsulate both their professional caliber and personal nuances.

Tech Stack

  • Frontend
    • Languages: JavaScript
    • Frameworks: React.js (Vite)
    • UI Components: ShadCN, TailwindCSS
    • Icons: Lucide Icons
  • Backend:
    • Languages: Node.js
    • Frameworks: Express
    • Authentication: Passport, OAuth2
  • Database: PostgreSQL
  • Hosting: Railway

Features

  • Resume Builder Interface:

    • Allow for user input to populate resume.
    • Generate PDF dynamically with user input
    • Allow users to download their resume in PDF format.
    • Add clear resume to button to reset fields
  • Account management:

    • Save resumes to your account.
    • Sign up and sign in with Github.
  • Resume management:

    • Create, update, and delete resumes.
    • Locate saved resumes on your account.

Demos

Resume Builder Interface

instacv-interface.mov

User Account Creation and Management

InstaCV.-.LOGIN.mov

Resume management

resume-management.mov

Installation Instructions

To install and run InstaCV locally, please follow these steps:

  1. Clone the repository to your local machine using the following command:

    git clone https://github.com/jamesjbustos/insta-cv.git
    
  2. Navigate to the project server and client directory and install the required dependencies:

    cd client ; npm install
    
    cd server ; npm install
    
  3. Go to root directory and run the following:

    npm start
    

ER Diagram

Screenshot 2023-11-21 at 3 37 37 AM

Tables

In this schema, we have the following relationships:

  1. One-to-Many Relationship:

    • users to resumes: Each user can have multiple resumes, but each resume is linked to only one user.
  2. Many-to-Many Relationship (Products to Tags):

    • resumes to tags: A resume can have multiple tags, and a tag can be associated with multiple resumes.

users

Column Type Properties
id int pk, increment
githubid varchar unique, not null
username varchar not null
avatarurl text
accesstoken text
registration_date timestamptz default: now()

resumes

Column Type Properties Indexes
resumeID int pk, increment userID
userID int ref: > users.id
creation_date datetime default: now()
content text
targeted_role varchar
templateID int ref: > templates.templateID
last_modified datetime default: now()

templates

Column Type Properties
templateID int pk, increment
name varchar
design varchar Refers to LaTeX template files
description varchar

tags

Column Type Properties
tagID int pk, increment
tag_name varchar

resume_tags

Column Type Properties Indexes
resumeID int ref: > resumes.resumeID (resumeID, tagID) [pk]
tagID int ref: > tags.tagID

Wireframes

Homepage

Homepage

Dashboard

Dashboard

Resume Builder

Resume Builder (1)

License

This project is licensed under the MIT License

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.