From 0d1b79876271b46f4246fc160e1dc9ced96a89bf Mon Sep 17 00:00:00 2001 From: Adam Ma Date: Thu, 7 Nov 2024 14:32:12 -0500 Subject: [PATCH 1/2] docs(readme): update the readme about how to start up our project --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 6fdf35cc0..2f1a8a728 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,21 @@

docker-pull-count + be-docker-pull-count Price

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) + +```bash +cd /rootPath +docker compose up --build -d # Detach from the terminal +``` + +Then you can open your browser, and navigate to the + ## Task Management As per github's task tracking flow is difficult to use, we decide to use [JIRA Boards](https://bu-cs673a2f24-team-5.atlassian.net/jira/software/projects/SCRUM/boards/1) to trace the progress and manage the risk. Click the hyperlink to check details. From 6ad6e3cf5c815b73666943f512100ec6b9d5ae87 Mon Sep 17 00:00:00 2001 From: Adam Ma Date: Thu, 7 Nov 2024 14:41:56 -0500 Subject: [PATCH 2/2] docs(readme): update the readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 2f1a8a728..dd1223a54 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,8 @@ This repository is a project for METCS673. This project focuses on using AI to a ## Steps to start up and test (For TA and professor) +### If you'd like to clone our project (Recommended) + ```bash cd /rootPath docker compose up --build -d # Detach from the terminal @@ -29,6 +31,15 @@ docker compose up --build -d # Detach from the terminal Then you can open your browser, and navigate to the +### 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](https://bu-cs673a2f24-team-5.atlassian.net/jira/software/projects/SCRUM/boards/1) to trace the progress and manage the risk. Click the hyperlink to check details.