<<<<<<< HEAD
Welcome to the HeartAI Documentation, your comprehensive guide to understanding and utilizing our predictive healthcare system. This document provides a comprehensive overview of the HeartAI system, including its frontend interface, backend architecture, AI model integration, and mobile application.
The HeartAI system is designed to inform users of their heart health, effectively encouraging them to take proper care of their hearts. By leveraging artificial intelligence (AI) models, users are sensitised on their risk of heart disease and also, receive personalized insights and guidance. In addition, the system facilitates seamless communication between users and the chatbot interface.
The HeartAI Frontend is a user-friendly web application interface that allows users to interact with the HeartAI system. Below is an overview of its features, components, and technologies used. The doctor and the patients are the users in this case.
- Certified Doctor Reports: Medical reports are generated directly through the application, providing additional insights and recommendations from healthcare professionals.
- Chatbot Integration: Users can interact with an AI chatbot to receive personalized insights and guidance based on predictions from their health data.
- Detailed Reports: Users can view detailed reports generated from their health data, providing comprehensive information about their heart health status and potential risk factors.
The HeartAI Backend serves as the core infrastructure of the HeartAI system, handling data analysis, machine learning, user authentication, and communication between users and healthcare professionals..
- Heart Disease Prediction: Predicts heart disease risk based on user input and medical records using advanced ML algorithms.
- User Authentication: Ensures secure user authentication via bcrypt and JSON Web Tokens (JWT).
- Medical Report Management: Allows users to upload and manage medical reports for precise prediction and communication.
- Scalability: Built on Express.js and MongoDB for high scalability and ease of extension.
/users
: Handles user management tasks./chat-messages
: Manages chat message interactions./medical-reports
: Facilitates management of medical reports./chat-sessions
: Manages chat session endpoints./predictions
: Handles heart disease prediction endpoints.
- Express.js: Web application framework for Node.js
- MongoDB: NoSQL database for storing user data, medical reports, and chat messages
- bcrypt: Password hashing library for secure user authentication.
- Joi: Data validation library for API input validation.
- JSON Web Tokens (JWT): Authentication mechanism for API requests.
- Other libraries and dependencies specified in
package.json
- Clone the repository: https://github.com/dzeble/Heart-Disease-Prediction-Group-2.git
- Navigate to the project directory:
cd heart-disease-system
. - Install dependencies:
npm install
. - Configure environment variables in a
.env
file. - Launch the server:
npm run dev
A web app for Doctors to send reports and prediction results to patients.
-
Doctor's Portal: Allows users to register or sign in to view pending report requests in the form of booked appointments. The doctor gets to see all patients, all generated reports and the healthy and unhealthy patients .Doctors are able to issue reportrequests by selecting patient and typing in patient heart details to generate a report.
-
Patient's Portal Patient signs up or signs in to be able to book for appointments from available doctors in system, view generated reports and also chat with bot concerning report.
- Header: Displays the HeartAI logo and a "Login" button for access.
- Hero Section : Welcomes users to the application and provides an overview of its purpose.
- Authentication Page : Allows doctors to sign in after verification.
- Features Section: Showcases key features of the HeartAI application.
- Footer: Displays the HeartAI logo and a "Get Started" button for quick access to the signup process.
- React.js: JavaScript library for building user interfaces.
- React Router: Library for routing in React applications.
- Material UI: React component library implementing Google's Material Design.
- Tailwind CSS: Utility-first CSS framework for rapidly building custom designs.
To set up and run the HeartAI Frontend on your local machine:
- Clone the repository or download the project files from https://github.com/dzeble/Heart-Disease-Prediction-Group-2.git .
- Install dependencies using
npm install
oryarn install
. - Start the development server with
npm run dev
oryarn dev
. - Access the application in your web browser at http://127.0.0.1:5173/
The HeartAI Mobile Application allows users to have access to heart disease predictions, and heart health management information through interactions with the system bot.
- Mobile Chatbot: ntegration of the AI chatbot into a mobile-friendly interface for seamless interaction.
- Dashboard: Visual representation of user health data and heart disease risk predictions.
- Book Appointment: Reservation for medication, appointments, and health check-ups to promote proactive health management.
- Fluttere: Dart framework for building native mobile applications.
- animate_do
- chatview
- awesome_dialog
- dio: Promise-based HTTP client for making requests from the mobile app to the server.
- widget_loading
- shared_preferences
- adaptive_theme
- rive
Run the following commands from your terminal:
git clone
https://github.com/dzeble/Heart-Disease-Prediction-Group-2.git to clone this repoflutter pub get
in the project root directory to install all the required dependencies.- From your terminal, run
flutter run
.
- Compatible with iOS and Android devices.
- Testing performed on various screen sizes and resolutions to ensure responsiveness.
HeartAI represents a paradigm shift in predictive healthcare, empowering individuals to take control of their heart health through data-driven insights and expert guidance. With its user-friendly interface, robust architecture, and emphasis on privacy and security, HeartAI is poised to revolutionize the way we approach preventive healthcare in the digital age.
Samuel Berchie Opoku, Sven Dzeble, Moro Njie, Emeralda Kusi Yeboah, Faddal Ibrahim, Isaac Takiyara Kanyiti, Jeffrey Ofori Kwakye, Manu Adam Onyina, Isaac Asiamah, Abdul Razak Abubakari.
You can have a different view of our app through our text documenation https://reallygreattech.atlassian.net/l/ce/zLU7a72u Or look up our presentation for a graphic view of the project https://docs.google.com/presentation/d/1kKyBZ7KIlsZSamtCHpwalDawTKrAagyB_vK7t5eTMzA/edit?pli=1#slide=id.g106ddb05087_0_625
5c9bb552ce5283780d11946f4122c902532af6f2