Skip to content

Latest commit

Β 

History

History
88 lines (65 loc) Β· 2.56 KB

File metadata and controls

88 lines (65 loc) Β· 2.56 KB

🌟 GlowPath

GlowPath is a progressive web application designed to enhance user safety by enabling real-time location sharing that can be shared easily via chat, and providing instant alerts to contacts or authorities via an SOS button.


πŸš€ Key Features:

  • Real-Time Location Sharing: Share your live location with a trusted contact list.
  • SOS Button: Notify contacts and authorities during emergencies with a personalized emergency button.
  • Safe Zone Mapping: View nearby safe zones like police stations and hospitals on an interactive map.
  • Safety Analytics: Visualize important safety statistics for better decision-making.

πŸ› οΈ Getting Started:

GlowPath is live! Visit the live version at https://glowpathorg.github.io/GlowPath/

To run GlowPath locally, ensure the following dependencies and accounts are set up:

  1. Node.js: Download and install Node.js.
  2. MongoDB: Set up a local or cloud-based MongoDB instance (e.g., MongoDB Atlas).
  3. API Keys:
  4. OpenStreetMap and Overpass API: No additional setup needed.

πŸ“¦ Installation:

1. Clone the repository:

git clone cd GlowPath

2. Install dependencies:

-root Directory npm install

  • server: cd server npm install

  • client: cd client npm install

3. Set up environment variables:

Create a .env file in the client for the weather API Key Create a .env file in the server directory and add the following: SERVER_PORT=3002 CLIENT_PORT=5173 MONGODB_URI=your_mongodb_connection_string JWT_SECRET=your_secret_key TWILIO_ACCOUNT_SID TWILIO_AUTH_TOKEN TWILIO_PHONE_NUMBER

πŸ’» Tech Stack

β€’ Frontend: React.js and Typescript β€’ Backend: Node.js with Express.js for routing and API logic. β€’ Database: MongoDB for storing data. β€’ Authentication: JSON Web Tokens (JWT) for secure user sessions. β€’ Mapping: Leaflet.js for an interactive map. β€’ APIs and Tools: HERE API Nominatim Twilio Openstreetmaps Overpass Weather API β€’ Others: Axios.

🀝 Contributing:

Contributions, issues, and feature requests are welcome! Feel free to check the issues page or submit a pull request.

Authors:

Enjoy using GlowPath, and stay safe! πŸšΆβ€β™‚οΈπŸ›‘οΈ