Skip to content

all3n2601/NavX

Repository files navigation

NavX - Car 🚘 and Bike 🏍️ Pooling with Women 👩‍🦰 Safety Surveillance 📹

Overview

This project is a comprehensive car and bike pooling application with an integrated women’s safety surveillance system. The system is built using a React Admin Dashboard, React Native applications for both users and drivers, and a Spring Boot backend. The key focus of the application is to provide a safe and efficient ride-sharing platform, with special emphasis on ensuring women's safety through real-time tracking and emergency alert systems.

Features

  • User and Driver Authentication: Secure login and registration for both users and drivers.
  • Ride Booking and Management: Users can book car and bike rides, and drivers can accept and manage ride requests.
  • Safety Surveillance: Real-time tracking, SOS alerts, and emergency notifications for women passengers.
  • Notifications: Push notifications for ride requests, acceptance, cancellations, and safety alerts.
  • Admin Dashboard: A comprehensive dashboard for managing the entire platform, including monitoring rides and handling safety alerts.

Tech Stack

  • Frontend (Admin Dashboard): React
  • Frontend (User and Driver Apps): Flutter
  • Backend: Spring Boot
  • Database: MongoDB (or any other relational database)
  • Notification Service: Firebase Cloud Messaging (FCM)
  • Deployment: Docker and AWS/Heroku for cloud hosting

Architecture

  • React Admin Dashboard: Provides administrators with the ability to monitor rides, users, and safety alerts in real-time.
  • React Native Apps: User and Driver apps allow users to book rides and drivers to manage ride requests. Integrated with GPS services for real-time location tracking.
  • Spring Boot Backend: Manages user authentication, ride booking, safety alerts, and communication between the apps.

Installation and Setup

Prerequisites

  • Node.js (v16 or higher)
  • Java (v11 or higher)
  • MySQL (or any relational database)
  • Firebase account (for push notifications)

Backend Setup

  1. Clone the repository:
    git clone https://github.com/all3n2601/NavX.git
    cd backend
  2. Configure MySQL Database:
    • Set up a MySQL database and update the connection details in application.yml
  3. Build and run the Spring Boot application:
    ./mvnw clean install
    ./mvnw spring-boot:run

Admin Dashboard Setup

  1. Clone the repository:
    git clone https://github.com/all3n2601/NavX.git
    cd frontend
  2. Install the dependencies:
    npm install
  3. Start the development server:
    npm run

User and Driver App Setup

  1. Clone the repository:
    git clone https://github.com/all3n2601/NavX.git
    cd userApp or cd driverApp
  2. Install the dependencies:
    npm install
  3. Run the app:
    npx expo start

Contributing

Contributions are welcome! Please follow these steps to contribute:

1.	Fork the repository.
2.	Create a new branch (git checkout -b feature-branch).
3.	Make your changes and commit them (git commit -m 'Add new feature').
4.	Push to the branch (git push origin feature-branch).
5.	Open a pull request.

Contact

If you have any questions or need further clarification, feel free to contact the project maintainer:

•	Name: Allen Febi M A   
    •	Name: Rahul Palanivel R
•	Name: Manigandan N  
    •	Name: Harihara Valliappan    

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •