Skip to content

[Docs] Update README #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 7, 2024
Merged

[Docs] Update README #71

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d1b798
docs(readme): update the readme about how to start up our project
adamma1024 Nov 7, 2024
6ad6e3c
docs(readme): update the readme
adamma1024 Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,21 @@
<p>
<!-- <img src="https://img.shields.io/github/license/BUMETCS673/seprojects-cs673a2f24_team5" alt="license"/> -->
<img src="https://img.shields.io/docker/pulls/adamma1024/cvcoach_web" alt="docker-pull-count" />
<img src="https://img.shields.io/docker/pulls/adamma1024/cvcoach_be" alt="be-docker-pull-count" />
<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>
</p>

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 <http://localhost:8081>

## 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.
Expand Down
Loading