Skip to content

Commit 0d1b798

Browse files
committed
docs(readme): update the readme about how to start up our project
1 parent 793d256 commit 0d1b798

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,21 @@
1414
<p>
1515
<!-- <img src="https://img.shields.io/github/license/BUMETCS673/seprojects-cs673a2f24_team5" alt="license"/> -->
1616
<img src="https://img.shields.io/docker/pulls/adamma1024/cvcoach_web" alt="docker-pull-count" />
17+
<img src="https://img.shields.io/docker/pulls/adamma1024/cvcoach_be" alt="be-docker-pull-count" />
1718
<a href="https://img.shields.io/badge/price-free-ff69b4"><img alt="Price" src="https://img.shields.io/badge/price-free-ff69b4?style=flat-square" /></a>
1819
</p>
1920

2021
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.
2122

23+
## Steps to start up and test (For TA and professor)
24+
25+
```bash
26+
cd /rootPath
27+
docker compose up --build -d # Detach from the terminal
28+
```
29+
30+
Then you can open your browser, and navigate to the <http://localhost:8081>
31+
2232
## Task Management
2333

2434
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.

0 commit comments

Comments
 (0)