Skip to content

baddif/ai_resume_optimizer

Repository files navigation

Project Logo

🚀 AI Resume Optimizer

A Website using AI to optimize resume for users into different versions. Built by React / PHP as WordPress Plugins.

CI Status Release License


💁 Online Experience

AI Resume Optimizer


🎥 Demo

Watch the video


📖 Introduction

  • Core Features: User inputs parts of the resume, for example, summary, project details, work experience, achievements, etc... The site calls AI APIs to optimize it. Suppport multiple versions of optimization.
  • Tech Stack: WordPress, JavaScript, PHP, MySQL
  • Frameworks: RESTful API, React, WordPress, Jest, PHPUnit, WP_Mock

👤 Author


🏗️ Background Story

While looking for remote jobs, I used AI a lot to help optimizing my resume. Then I decided to make a website to easy the use of AI assistanted optimization, also as a way to learn WordPress / PHP / Plugins. So this is the first project I built with WordPress.


🧩 Architecture Design

Architecture Diagram

  • System Modules: -- WordPress and Nginx for the server. -- Using Postfix as my own mail server. -- Using React for plugin pages, communicating with PHP backend through RESTful APIs. -- Call Hugging Face free API for the AI ability.
  • Design Considerations and Trade-offs: -- Install my own mail server because I cannot register to some free mail service good enough. -- Have a lot to improve as this is my first WordPress / PHP project.
  • Known Issues / Improvement Directions: -- The 3 plugins can be merged into 1. -- The cache in React Pages is not necessary. This is over design. It involved too much complexity, just for little user experience on the frontend pages... and the experience may not be any difference to end users. -- The session management is not very well, need to be improved.

📌 Usage

# Clone the repository
git clone [email protected]:baddif/ai_resume_optimizer.git
cd ai_resume_optimizer

# Install dependencies
cd src/career-baist-plugin
npm install # only 1 plugin need to install dependencies

# Start the service
./build.sh
# -- Then upload the 3 zip files in build directory as plugins to WordPress.
# -- In WordPress, build 3 pages and write short code in it:
#   -- Page slug: welcome, short code: [guest_optimize]
#   -- Page slug: my_career, short code: [dashboard_page]
#   -- Page slug: reset-password, short code: [reset-password]

# Test
./run_all_tests.sh

About

AI powered resume optimizer, WordPress based, React plugin website.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages