Making healthcare information, emergency resources, and essential medical support more accessible through technology.
RELIEF is an AI-assisted healthcare web platform designed to help people access symptom guidance, discover healthcare providers, explore nearby medical resources, and learn essential first-aid practices through a responsive, user-friendly interface.
We aim to build a more accessible healthcare experience through thoughtful design, useful digital tools, and community-driven open-source development.
π Live Demo: relief-gamma.vercel.app
π» Repository: SohamMondal88/RELIEF
- About the Project
- Our Mission
- Key Features
- Technology Stack
- Project Structure
- Getting Started
- How to Contribute
- Contribution Guidelines
- Good First Contributions
- Reporting Bugs
- Security and Privacy
- Medical Disclaimer
- Roadmap
- License
- Join the Community
Accessing reliable healthcare information and finding appropriate medical resources can be challenging, particularly during stressful situations.
RELIEF aims to simplify this experience by bringing essential healthcare resources together in one web platform.
The project focuses on usability, accessibility, responsive design, and practical healthcare support. It is being developed as an open-source initiative where developers, designers, students, testers, and healthcare-technology enthusiasts can collaborate.
Whether you are fixing a small UI issue, improving accessibility, documenting a feature, or proposing a new capability, your contribution can help make RELIEF better.
Our mission is to make essential healthcare information and support resources easier to access through simple, inclusive, and dependable technology.
We aim to:
- Improve access to general health information and symptom guidance.
- Help users discover doctors, hospitals, and pharmacies.
- Make emergency and ambulance resources easier to find.
- Provide understandable first-aid information.
- Create accessible and responsive experiences across devices.
- Encourage responsible innovation in healthcare technology.
- Build an open-source community that values collaboration, quality, and transparency.
A symptom-checking interface intended to help users explore general health information and possible next steps.
Healthcare-provider discovery and appointment-related interfaces designed to simplify the process of finding medical support.
A dedicated module for exploring hospital information and relevant healthcare resources.
A pharmacy-related module intended to help users locate or explore pharmacy resources.
Emergency-oriented interfaces that make ambulance and urgent-care resources easier to access.
Educational first-aid information intended to help users understand basic responses to common situations.
A dashboard with demonstration features such as medication reminders and a health timeline. Current demo behavior should not be mistaken for a verified medical record or a production reminder service.
Demonstration interfaces for administrative and doctor-related workflows, with opportunities to improve authorization, usability, and operational functionality.
A web interface built with HTML, CSS, and JavaScript, with Leaflet.js used for map-related functionality.
Quick language-selection options for English, Hindi, and Bengali, where supported by the relevant interface.
Development note: Feature availability, integrations, data sources, and persistence may differ between demonstration and production behavior. Contributors should verify implementation before describing a feature as fully operational.
| Technology | Purpose |
|---|---|
| HTML5 | Page structure and semantic markup |
| CSS3 | Styling, layouts, animations, and responsive design |
| JavaScript | Client-side interactions and application behavior |
| Leaflet.js | Interactive maps |
| LocalStorage | Browser-side persistence for supported demonstration features |
| Vercel | Live demonstration and deployment |
The existing project is primarily a frontend web application. Contributors should inspect the current code before introducing additional frameworks, backend services, or dependencies.
The repository contains page-specific styles, shared styling, images, and the main website pages.
RELIEF/
βββ .github/
β βββ FUNDING.yml
βββ assets/
β βββ css/
β β βββ style.css
β β βββ auth.css
β β βββ about.css
β β βββ appointments.css
β β βββ doctors.css
β β βββ hospitals.css
β β βββ pharmacies.css
β β βββ ambulances.css
β β βββ firstaid.css
β β βββ symptoms.css
β β βββ dashboard.css
β β βββ ...
β βββ images/
β βββ hero-image.jpeg
β βββ app-screens.png
β βββ logo.jpg
β βββ ...
βββ LICENSE
βββ README.md
This is a representative structure, not an exhaustive file listing. Refer to the repository for the complete directory tree.
Follow these steps to set up RELIEF locally.
- Git installed on your computer.
- A modern web browser.
- A code editor such as Visual Studio Code.
- An internet connection for resources that load from external services.
Open the repository:
https://github.com/SohamMondal88/RELIEF
Click Fork to create your own copy.
Replace YOUR_USERNAME with your GitHub username.
git clone https://github.com/YOUR_USERNAME/RELIEF.git
cd RELIEFgit remote add upstream https://github.com/SohamMondal88/RELIEF.git
git remote -vOpen the project folder in Visual Studio Code.
code .If the code command is unavailable, open the folder directly from your editor.
For a basic static preview, open index.html in your browser.
For a more reliable local development environment, use the Live Server extension in VS Code and select Open with Live Server.
If a feature depends on external APIs, browser permissions, or a server-side service, follow the corresponding configuration instructions before testing it.
Always work on a separate branch instead of making your changes directly on main.
git checkout main
git pull upstream main
git checkout -b feature/your-feature-nameExamples:
git checkout -b fix/mobile-navigation
git checkout -b feat/accessible-symptom-form
git checkout -b docs/local-setupContributions of all sizes are welcome, including contributions from first-time open-source developers.
- Read this README.
- Run the website locally.
- Explore the existing pages and navigation.
- Identify an improvement or review the project's open issues.
Look for an existing issue that matches your skills and interests.
If you want to introduce a significant feature, open an issue first to discuss the proposed approach and avoid duplicate work.
- Follow the existing coding conventions.
- Keep changes focused and easy to review.
- Reuse existing components and styles when practical.
- Preserve working functionality.
- Avoid unrelated modifications.
Before submitting your work:
- Check the affected pages in a browser.
- Test desktop, tablet, and mobile layouts.
- Verify navigation links and interactive elements.
- Check browser console errors.
- Confirm images, icons, and other assets load correctly.
- Test loading, empty, error, and success states where relevant.
- Check keyboard accessibility and visible focus states.
- Confirm that your changes do not introduce broken links or obvious regressions.
Use a clear, descriptive commit message.
git add .
git commit -m "fix: improve mobile navigation"Other examples:
feat: add accessible appointment form
fix: correct broken image paths
style: improve dashboard responsiveness
docs: clarify local setup instructions
test: verify navigation interactions
git push -u origin feature/your-feature-nameVisit your fork on GitHub and select Compare & pull request.
Your pull request should explain:
- What you changed.
- Why the change is necessary.
- Which issue it addresses, if applicable.
- How you tested it.
- Any limitations or follow-up work.
- Before-and-after screenshots for visual changes.
Submit your pull request against the repository's main branch unless the maintainers specify another target.
Please wait for review and address requested changes before considering the contribution complete.
To keep the project maintainable, contributors should follow these principles.
- Write readable, maintainable code.
- Use descriptive variable and function names.
- Avoid duplicated logic where a shared implementation is appropriate.
- Remove unused code introduced by your changes.
- Handle errors gracefully.
- Avoid adding unnecessary dependencies.
- Follow the existing visual design and component conventions.
- Use semantic HTML elements.
- Make layouts responsive across common screen sizes.
- Provide meaningful labels for form fields.
- Ensure sufficient color contrast.
- Support keyboard navigation and visible focus indicators.
- Respect reduced-motion preferences when implementing animations.
- Avoid breaking existing navigation or page layouts.
- Do not present generated or unverified information as a confirmed diagnosis.
- Do not introduce unsupported medication recommendations or dosages.
- Do not fabricate doctors, hospital listings, pharmacy information, or emergency contact details.
- Clearly identify mock, sample, and demonstration data.
- Use trustworthy sources when adding health education content.
- Protect personal and sensitive information.
- Never commit API keys, passwords, tokens, or private patient information.
- Keep each pull request focused on a logical change.
- Explain the motivation behind the change.
- Include screenshots for UI changes.
- Describe any required configuration changes.
- Disclose any known limitations.
- Do not claim tests passed unless they were actually run.
New contributors can start with small, well-defined improvements.
| Area | Example contribution |
|---|---|
| Documentation | Improve setup instructions or explain a module |
| UI/UX | Fix spacing, typography, and visual consistency |
| Responsiveness | Correct mobile navigation or overflowing layouts |
| Accessibility | Add labels, keyboard support, and focus indicators |
| Bug fixes | Repair broken links or missing assets |
| JavaScript | Improve form validation and error handling |
| Testing | Document manual test cases for important pages |
| Performance | Optimize images and reduce unnecessary work |
| Localization | Improve English, Hindi, or Bengali interface text |
| Healthcare content | Improve clarity and sourcing of educational material |
Before starting work on a larger issue, check whether someone is already addressing it.
If an issue-assignment process is used by the maintainers, follow the instructions in that issue before beginning.
Found a bug? Please report it through the repository's GitHub Issues section.
https://github.com/SohamMondal88/RELIEF/issues
Include the following information:
- Title: A short description of the problem.
- Environment: Browser, operating system, and device type.
- Steps to reproduce: Clear steps that another contributor can follow.
- Expected behavior: What should happen.
- Actual behavior: What happened instead.
- Screenshots or logs: Include them when useful, after removing personal information and secrets.
For security vulnerabilities, do not publish sensitive exploit details in a public issue. Contact the maintainers privately through an available security-reporting channel.
Healthcare applications require particular care when handling personal information.
Contributors should:
- Never commit credentials or private API keys.
- Avoid collecting unnecessary personal information.
- Never use real patient records as test data without proper authorization and safeguards.
- Avoid logging sensitive information.
- Review third-party services before introducing them.
- Clearly explain any new permissions or data collection.
- Use secure server-side validation and authorization if backend functionality is introduced.
Client-side validation alone is not a security boundary. Any future backend that handles sensitive information must enforce appropriate access controls on the server.
RELIEF is an informational and educational technology project. Its symptom guidance and related features are not a substitute for professional medical evaluation, diagnosis, or treatment.
The platform must not be treated as a verified emergency dispatch service unless such functionality has been implemented and independently validated.
In a medical emergency, contact the appropriate local emergency service or seek immediate professional medical assistance. Do not delay urgent care while using this website.
Contributors must not introduce features that imply clinical validation, medical certification, guaranteed accuracy, or emergency-service integration without evidence and appropriate review.
The following are potential areas for continued development, subject to prioritization and technical review.
- Improve accessibility across all pages.
- Strengthen responsive layouts and navigation consistency.
- Expand automated and manual testing.
- Improve error handling and user feedback.
- Review health-content sourcing and disclaimers.
- Improve the reliability of doctor, hospital, and pharmacy information.
- Evaluate secure backend integration where needed.
- Introduce robust authentication and authorization if required.
- Improve multilingual coverage.
- Enhance performance and maintainability.
- Expand contributor documentation and onboarding.
These items are proposed development goals, not claims that the functionality is already implemented.
RELIEF is distributed under the MIT License. See the LICENSE file for the complete license text.
By contributing, you agree that your contributions will be distributed under the project's applicable license.
Have an idea, found a bug, or want to contribute?
- β Star the repository if you find the project useful.
- π΄ Fork the repository to start contributing.
- π Report a bug or suggest an improvement.
- π§ Submit a pull request with your improvements.
- π Help improve documentation and contributor onboarding.
- π± Encourage new developers to participate in open source.
Repository: https://github.com/SohamMondal88/RELIEF
Live Demo: https://relief-gamma.vercel.app
Every meaningful contribution helps us move toward a more accessible, usable, and responsible healthcare experience.
Built with care by the RELIEF project community.