CVCoach

This repository is a project for METCS673. This project focuses on using AI to automate and improve the process of resume evaluation and interview preparation. By incorporating Retrieval-Augmented Generation (RAG), we ensure that our application can provide more accurate, context-relevant reviews.

Steps to start up and test (For TA and professor)

If you'd like to clone our project (Recommended)

cd /rootPath
docker compose up --build -d # Detach from the terminal

Then you can open your browser, and navigate to the http://localhost:8081

If you'd like to pull docker images

We have two images separated for BE and FE.

1. adamma1024/cvcoach_be
2. adamma1024/cvcoach_web

Please make sure you've pulled all them on latest version (check it on Docker Hub) and start them correctly.

Task Management

As per github's task tracking flow is difficult to use, we decide to use JIRA Boards to trace the progress and manage the risk. Click the hyperlink to check details.

CHANGELOG

📖 CHANGELOG.md

How to start it with Docker?

Learn the Docker commands here.

cd /rootPath
docker compose up --build -d # Make sure you've installed the Docker locally.

Then, open your browser with https://localhost:8081 (The default port is 8081)
The -d is detached session mode, you can check your docker container with command:

docker ps
docker stop/kill <container_id> # And stop your service with container id
# Or docker compose down/stop directly
docker compose down/stop

Design Docs

📖 Design Docs
📖 SDD

How to contribute this project?

Tips: Make sure there is no repeated issues or PRs before opening a new one.

🎤 Commit an issue

⌨️ Raise a PR

📖 Development manual

What's the CI/CD processes of this project?

📔 CI/CD Intro Developing workflow video