Skip to content

Latest commit

 

History

History
114 lines (74 loc) · 3.92 KB

README.md

File metadata and controls

114 lines (74 loc) · 3.92 KB

🌍📍 Locate Me Backend

Welcome to the Locate Me backend! This project is designed to empower people with disabilities by helping them share their location and needs with trusted contacts such as volunteers, NGOs, family members, and good Samaritans. ❤️

🎯 Project Aim

The goal of the Locate Me project is to create a React Native app with voice control and a minimal UI to ensure it is accessible and easy to use for individuals with disabilities. The app will be a vital tool for communities to assist those in need, offering a way to connect with help quickly and efficiently.

By enabling users to share their exact location and the assistance they require, this platform helps connect those who need aid with people who can offer it. We aim to create a safe, supportive, and connected environment. 🌱

🚀 Technology Stack

  • Backend: Node.js, Prisma, MySQL
  • Frontend: React Native with voice interaction
  • Database: MySQL (for storing user locations, group associations, family members, and more)
  • Authentication: JWT tokens for secure user sessions
  • Deployment: Coming soon...

🔧 Key Features

  • Location Sharing: Users can share their current location with designated groups and family members. 🗺️
  • Family & Groups Management: Users can belong to multiple families and groups, allowing for flexible associations. 👨‍👩‍👧‍👦
  • Voice Capabilities: The app will leverage voice control to offer a minimal UI experience, making it easier for people with disabilities to navigate the app. 🎙️
  • Real-time Assistance: Volunteers and family members can offer real-time support based on the location and needs shared by the users. 🤝

🏗️ How to Set Up

Prerequisites:

  • Node.js (v14 or above)
  • MySQL
  • Prisma CLI

Installation:

  1. Clone the repository:

    git clone repo link

  2. Install dependencies:

    cd locate-me-backend
npm install

  3. Set up your environment variables:

    • Create a .env file in the root directory.
    • Add your database connection string and other relevant environment variables.

  4. Run migrations to set up your database:

    npx prisma migrate dev

  5. Start the development server:

    npm run dev

🛠️ Current Features in Development

  • Voice command integration 🎤
  • Group and family management 👪
  • Location history for trusted contacts 🗂️
  • Minimal UI with accessibility in mind 🧑‍🦯

💬 Contributions

🚧 Contribution guidelines coming soon! 🚧

We’re working hard to ensure this project becomes a safe and accessible space for all. Stay tuned for detailed contribution guidelines, including our code of conduct and best practices. In the meantime, feel free to fork the project and experiment with it. 🎉

📣 Get Involved

Want to be a part of this amazing journey? Here’s how you can help:

  • 🐛 Find and report bugs
  • ✨ Suggest new features
  • 🔨 Contribute code to improve the app
  • 🗣️ Share with others who might benefit from or contribute to the project

🌟 Our Vision

We believe in a world where technology breaks down barriers and offers equal opportunities for everyone, regardless of ability. The Locate Me app is just one step toward a more inclusive society, where people with disabilities can feel empowered, safe, and connected. 💡

✨ License

This project is licensed under the MIT License. Feel free to use, modify, and distribute it as you see fit!

🫂 Join the Movement

Follow us on GitHub and social media to stay updated! Together, we can make a difference in the lives of millions. 🌍✨

🎉 Thank you for visiting! We can’t wait to see how you can help make Locate Me an essential tool for communities in need. 😊