This project provides a user interface for uploading pathology images, predicting their labels, and adding comments and annotations to specific samples. This README specifically covers the React frontend of the application.
Full Project Demo: https://www.loom.com/share/434f009b5d61432da6ca36f963c73f98
There are three separate components for this project:
- ML Model: https://github.com/VSTARprojects/pc_ml
- FrontEnd: https://github.com/VSTARprojects/pc_fe
- BackEnd: https://github.com/VSTARprojects/pc_dj
- Node.js and npm (Node Package Manager) installed on your machine. You can download them from the official website: https://nodejs.org/en/.
- Access to the backend API that the React site is designed to communicate with. This API should be up and running before attempting to use the React site. (refer https://github.com/VSTARprojects/pc_dj)
To install and run the frontend, follow these steps:
- Clone the repository to your local machine.
- Navigate to the frontend directory in your terminal.
- Run
npm installto install the necessary dependencies. - Run
npm startto start the development server.
Once the development server is running, you can access the website by visiting http://localhost:3000 in your web browser.