Skip to content

feat(docs): add relevant links to project documentation #15

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
hoangsonww merged 3 commits into from
Jul 11, 2025
Merged

feat(docs): add relevant links to project documentation #15

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9130d5f
feat(docs): add links to frontend repo
hoangsonww Jul 11, 2025
c00b125
feat(docs): add links to frontend repo
hoangsonww Jul 11, 2025
da72901
feat(docs): add links to frontend repo
hoangsonww Jul 11, 2025
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
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

AugMed is a web application, built for the UNC-Chapel Hill DHEP Lab, that allows the lab to collect data from participants in a user-friendly way. The app is designed to be used on any devices, and it allows participants to answer questions about their judgements for cases with potential Colorectal Cancer (CRC). The app is built using React, and the backend API is built using Flask and Python.

**Live Website**: **[https://augmed1.dhep.org/](https://augmed1.dhep.org/).**
Copy link

Copilot AI Jul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The period at the end of the link is inside the bold syntax, which may render inconsistently. Consider moving the period outside the closing ** so the link text is not bolded with the punctuation.

Suggested change
**Live Website**: **[https://augmed1.dhep.org/](https://augmed1.dhep.org/).**
**Live Website**: **[https://augmed1.dhep.org/](https://augmed1.dhep.org/)**.

Copilot uses AI. Check for mistakes.

![Python](https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white)
![Flask](https://img.shields.io/badge/Flask-000000?style=for-the-badge&logo=flask&logoColor=white)
![PostgreSQL](https://img.shields.io/badge/PostgreSQL-4169E1?style=for-the-badge&logo=postgresql&logoColor=white)
Expand All @@ -27,6 +29,9 @@ AugMed is a web application, built for the UNC-Chapel Hill DHEP Lab, that allows
![GitHub](https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github&logoColor=white)
![Postman](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white)

> [!NOTE]
> **Frontend Repository**: **[DHEP Lab AugMed Frontend](https://github.com/DHEPLab/augmed-app).**

## Local Environment Setup

Clone the repository if you haven't done so already, then follow these steps to set up your local environment:
Expand Down Expand Up @@ -83,7 +88,7 @@ To run the application locally, follow these steps:
flask run --host=127.0.0.1 --port=5001
```

> [!NOTE]
> [!IMPORTANT]
> If your frontend is also running, ensure it is configured to communicate with this backend API. You may need to set the API URL in your frontend configuration.
> Also, you might need to use CORS (Cross-Origin Resource Sharing) if your frontend and backend are served from different origins. You can use the `flask-cors` package to handle this:
> ```shell
Expand Down