markdown
SafeLink is a React Native application designed to assist medical professionals in generating and managing patient safety checklists. Powered by advanced AI (Gemini API), SafeLink ensures that patient safety protocols are followed with precision and empathy.
Watch on youtube - https://youtu.be/QS6O6-11tpY?si=W7QvUgphruG4EW61
- AI-Generated Checklists: Generate professional, step-by-step patient safety checklists using the Gemini API.
- Save and Manage Checklists: Save multiple checklists and access them anytime in the "My Checklist" section.
- Detailed Checklist View: View full details of any checklist by clicking on it.
- User-Friendly Interface: Intuitive and responsive UI for seamless navigation.
- Cross-Platform: Works on both iOS and Android devices.
- Node.js (v14 or higher)
- React Native CLI or Expo CLI
- Android Studio or Xcode (for running on emulators)
-
Clone the repository:
git clone https://github.com/your-username/safelink.git cd safelink -
Install dependencies:
npm install
-
Set up environment variables:
- Create a
.envfile in the root directory. - Add the following variables:
BACKEND_URL=http://your-backend-url GEMINI_API_KEY=your-gemini-api-key
- Create a
-
Start the Metro bundler:
npm start
-
Run the app:
- For iOS:
npx react-native run-ios
- For Android:
npx react-native run-android
- For iOS:
The backend is responsible for handling API requests to the Gemini API and managing saved checklists.
- Node.js
- Firebase Admin SDK (for saving checklists)
-
Navigate to the backend directory:
cd safelink-backend -
Install dependencies:
npm install
-
Set up environment variables:
- Create a
.envfile in the backend directory. - Add the following variables:
GEMINI_API_KEY=your-gemini-api-key FIREBASE_CONFIG=your-firebase-config
- Create a
-
Start the backend server:
node index.js
safelink/
├── safelink-mobile/ # Frontend (React Native)
│ ├── screens/ # All screen components
│ ├── context/ # Context for shared state
│ ├── App.js # Main entry point for the app
│ └── other files...
├── safelink-backend/ # Backend (Node.js)
│ ├── index.js # Main backend server file
│ ├── firebase-adminsdk.json # Firebase configuration
│ └── other files...
└── README.md # Project documentation
- Open the app and navigate to the "AI" tab.
- Enter patient information and click "Generate Checklist" to create a safety checklist.
- Save the checklist to the "My Checklist" section.
- View saved checklists in the "My Checklist" tab and click on any checklist to view full details.
- React Native
- React Navigation
- Context API
- Node.js
- Express.js
- Firebase Admin SDK
- Gemini API
Contributions are welcome! Follow these steps to contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature-name
- Commit your changes:
git commit -m "Add feature-name" - Push to the branch:
git push origin feature-name
- Open a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
For any inquiries or feedback, feel free to reach out:
- Email: sanjaysakthivel2000@gmail.com, vrameshkutti@hawk.iit.edu
- GitHub: kuttivicky
- Gemini API for powering the AI-generated checklists.
- React Native for the mobile framework.
- Firebase for backend services.
.