Know Your Sight is an AI-powered web platform designed to make eye disease detection faster, smarter, and more accessible for everyone. Built with medical professionals and the general public in mind, the platform analyzes retinal images using a custom-trained EfficientNet B0 model to detect cataracts, glaucoma, diabetic retinopathy, or confirm normal eye conditions with 92% accuracy. Users can access the platform directly through a browser with just a few clicks.
The platform consists of the following pages:
- Home: The landing page of the application.
- About Us: Provides information about the team and the project.
- Introduction: Explains how to use the platform and the technology behind it.
- Login: Allows users to log in to their accounts.
- Register: Allows new users to create an account.
- Detection: The core feature of the platform, where users can upload retinal images for analysis.
- History Detection: Displays the user's past detection results.
- Download PDF: Allows users to download their detection results as a PDF file.
- Upgrade Plan: Provides options for users to upgrade their subscription plan for more features.
The frontend of Know Your Sight is built with the following technologies:
- React: A JavaScript library for building user interfaces.
- Vite: A fast build tool for modern web projects.
- TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.
- Tailwind CSS: A utility-first CSS framework for rapid UI development.
- React Router: A declarative routing library for React.
- Axios: A promise-based HTTP client for the browser and Node.js.
- React Hook Form: A library for managing forms in React.
- Zod: A TypeScript-first schema declaration and validation library.
- Material-UI: A popular React UI framework.
- Lucide React: A library of simply beautiful icons.
- jsPDF: A library to generate PDFs in JavaScript.
- html2canvas: A library to capture screenshots of web pages or parts of it.
To get a local copy up and running, please follow these simple steps.
- npm
npm install npm@latest -g
- Clone the repo
git clone https://github.com/your_username_/know-your-sight.git
- Install NPM packages
npm install
- Run the development server
npm run dev
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.