Resumiser - Efficient AI Resume Builder

Team Members

• Ayden - Resumizer - branch: ayden
• Danny - dcapua - branch: danny
• Earth - earthcha - branch: earth
• Henry - phhoang98a - branch: henry

Features

• Build your resume with AI

Latest Demo Mockups

Sprint 2

• Design: https://www.figma.com/file/m1DXq5G9wP9tpF1SeZoF5d/Resumizer?type=design&node-id=204%3A111&mode=design&t=ofxu7vmKRs0PRRI2-1

Update 02/09/2024

Light Mode Design (Visual Desgin Live Demo Edition 1)

Dark Mode Design (Visual Desgin Live Demo Edition 1)

Front-End

Tech stack

• ReactJS
• JavaScript/HTML/CSS
• Tailwind CSS

Setup

Use yarn

1. Clone the repository
2. Type cd frontend in terminal
3. Install the dependencies by running yarn install (NodeJS and yarn are prerequisites, use npm install --global yarn to install all dedendencies of yarn after NodeJS was installed).
4. Start the development server by running yarn dev (if you want to build, use yarn build in /frontend and the built file will be in the /frontend/dist directory)
5. Open http://localhost:5173 in your browser

Use npm

1. Clone the repository
2. Type cd frontend in terminal
3. Install the dependencies by running npm install (NodeJS is a prerequisite).
4. Start the development server by running npm run dev (if you want to build, use npm run build in /frontend and the built file will be in the /frontend/dist directory)
5. Open http://localhost:5173 in your browser

Back-end

Job Server

Setup

1. cd /backend/JobServer
2. Install the dependencies by running pip install -r requirements.txt
3. Start the development server by running flask run

Apis

POST - https://resumizer-7n3e.onrender.com/jobs

Body(JSON): 
- "job_title": Title of the job (Software engineer)
- "country": Country of job posts
- "location": Specific location (optional)

Use the exact name, * indicates support for Glassdoor:

|                      |              |            |                |
|----------------------|--------------|------------|----------------|
| Argentina            | Australia*   | Austria*   | Bahrain        |
| Belgium*             | Brazil*      | Canada*    | Chile          |
| China                | Colombia     | Costa Rica | Czech Republic |
| Denmark              | Ecuador      | Egypt      | Finland        |
| France*              | Germany*     | Greece     | Hong Kong*     |
| Hungary              | India*       | Indonesia  | Ireland*       |
| Israel               | Italy*       | Japan      | Kuwait         |
| Luxembourg           | Malaysia     | Mexico*    | Morocco        |
| Netherlands*         | New Zealand* | Nigeria    | Norway         |
| Oman                 | Pakistan     | Panama     | Peru           |
| Philippines          | Poland       | Portugal   | Qatar          |
| Romania              | Saudi Arabia | Singapore* | South Africa   |
| South Korea          | Spain*       | Sweden     | Switzerland*   |
| Taiwan               | Thailand     | Turkey     | Ukraine        |
| United Arab Emirates | UK*          | USA*       | Uruguay        |
| Venezuela            | Vietnam      |            |                |


Result: List of job information about company, title, date_posted, job_url, location, site

Resume Server

Setup

1. cd /backend/ResumeServer
2. Install the dependencies by running npm install
3. Start the development server by running npm start

Apis

POST - https://tiny-teal-swordfish-cap.cyclic.app

Body(form-data): 
- resume (File): PDF file
- jobTitle (text)
- openAIkey (text) 

Result: The new content of the resume.

POST - https://tiny-teal-swordfish-cap.cyclic.app/prompt

Body(JSON): 
- prompt (text)
- openAIkey (text) 

Result: The new content of the resume.

Monitors CPU, memory, and bandwidth usage

Job Server

The current Render free hosting: 0.1 CPU(10% of a single CPU core's computational capacity), 512 MB (Ram)

• The average duration of JobSpy Api is 6s

• The CPU usage metric indicates the system-wide CPU usage, which includes the usage of all processes running on the system.

  During the API runtime, the CPU usage is 58%. The metric is 26% after finishing

• The Memory usage metric indicates the physical memory used by the JobServer process. It includes the memory used by the process's code, data, and shared libraries that are currently in physical memory (RAM). The memory usage of the FastAPI process increases as new memory is allocated to accommodate these operations

  Before the API runtime, the Memory usage is 125MB. The metric is 129MB after finishing

• The bandwidth usage is the sum of the request body size and the response body size for each API caller.

Resume Server The current free hosting: 1 GB of runtime memory, 1024 MB (Ram)

The CPU, memory, and bandwidth usage of resume generation by PDF Api:

The CPU, memory, and bandwidth usage of resume generation by prompt Api:

Database

• TBD

API

• OpenAI API - GPT