Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated README for navigable table of contents #1140

Merged
merged 1 commit into from
Nov 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 25 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,29 @@
<!--Line-->
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="900">

## DESCRIPTION 📑
## Table of Contents
- [DESCRIPTION](#description)
- [Why We Need This Application](#why-we-need-this-application)
- [Problem Statement](#problem-statement)
- [Solution](#solution)
- [Key Features](#key-features)
- [Contributing](#contributing)
- [Contribution Guidelines](#contribution-guidelines)
- [Tech Stack](#tech-stack)
- [User-Friendly Experience](#user-friendly-experience)
- [Future Enhancements](#future-enhancements)
- [Our Valuable Contributors](#our-valuable-contributors)
- [Team](#team)

## DESCRIPTION
A mobile app using HTML, CSS, JavaScript, and Google API that helps users find nearby hospitals and track ambulances in real-time. It shows hospital locations, provides directions, and helps manage ambulance routes based on traffic and distance.

Please check out the [Screenshots.md](./Screenshots.md) for more clarity on the description of the project.

<!--Line-->
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="900">

## 🌟 Why We Need This Application
## Why We Need This Application

1. **Quick Emergency Response**: Ensures patients receive timely medical assistance by locating the nearest hospitals and ambulances.
2. **Real-Time Tracking**: Provides real-time updates on ambulance locations and traffic conditions, optimizing route management.
Expand All @@ -66,7 +80,7 @@ Please check out the [Screenshots.md](./Screenshots.md) for more clarity on the
<!--Line-->
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="900">

## 🛠 Problem Statement
## Problem Statement
While having the name and address of a hospital is useful, visualizing it on a map with precise directions is even more effective. This app aims to bridge that gap by delivering real-time location data and navigation assistance, ensuring users find the nearest hospital quickly and with ease. 🚑

### 🌟 Quick Access to Hospitals
Expand All @@ -77,7 +91,7 @@ Visual information is key. Beyond just showing names and addresses, the app prov

<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="900">

## 💡 Solution
## Solution

### 🚑 Quick Access to Hospitals
This app offers a comprehensive list of nearby hospitals with essential details such as addresses, contact numbers, and user ratings. Users can filter based on hospital specialties, helping them find the appropriate medical help efficiently.
Expand All @@ -88,7 +102,7 @@ The built-in map feature shows exact hospital locations, provides directions, an
<!--Line-->
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="900">

## 🚀 Key Features
## Key Features

### 🚑 Operator Interface
- **🔐 Registration & Sign-In**: Operators can create accounts and securely log in for system access.
Expand All @@ -108,7 +122,7 @@ The built-in map feature shows exact hospital locations, provides directions, an
<!--Line-->
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="900">

## Contributing
## Contributing

We welcome all contributions from the open-source community! If you'd like to contribute, follow these steps:

Expand Down Expand Up @@ -155,7 +169,7 @@ node server.js

6. make sure that both Backend and index.html file run togethere.

## 🛠 Contribution Guidelines:
## Contribution Guidelines:

We welcome all contributions to improve **AmbuFlow**! If you would like to contribute, please follow the [Contributing.md](./Contributing.md) to know how to get started.

Expand All @@ -172,7 +186,7 @@ Refer to [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our community g
<!--Line-->
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="900">

## 🛠 Tech Stack
## Tech Stack

<a href="https://skillicons.dev">
<img margin="8px" src="https://skillicons.dev/icons?i=html,css,js" />
Expand All @@ -184,11 +198,11 @@ Refer to [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our community g
<!--Line-->
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="900">

## 📱 User-Friendly Experience
## User-Friendly Experience

This app is designed to be user-friendly, ensuring a seamless experience for both patients and ambulance drivers. The intuitive interface and real-time updates make it easy to navigate and use, even in high-stress situations.

## 📈 Future Enhancements
## Future Enhancements

- **Integration with Emergency Services** for faster response times.
- **Real-Time Communication** between patients and ambulance drivers.
Expand All @@ -205,7 +219,7 @@ This app is designed to be user-friendly, ensuring a seamless experience for bot
<!--Line-->
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="900">

## 👥 Team
## Team

| <img title="Mansi Ruhil" src="https://avatars.githubusercontent.com/u/157950124?v=4&" alt="Mansi Ruhil" width="75"/> |
|:--:|
Expand Down