Skip to content

Latest commit

 

History

History
84 lines (50 loc) · 2.22 KB

README.md

File metadata and controls

84 lines (50 loc) · 2.22 KB
Raw

Women's Safety Web App

Overview

This web application is designed to enhance women's safety by providing a platform where they can seek help in distress situations. The app allows users to send distress signals, report incidents, and provides an admin panel to manage and review incident reports.

Key Features

  • Distress Signal: Users can press a button on the homepage to send a distress signal. An email is sent to the user's relatives, parents, and nearby individuals with a map displaying the user's location.

  • Incident Reporting: Users can report incidents via a form, providing crucial information about the incident.

  • Admin Panel: Admins can access an admin panel to view and manage all incident reports, including details of distress signals.

  • Media Storage: Media files, such as images or videos related to incidents, are stored in an AWS S3 bucket for secure and scalable storage.

Technologies Used

  • MERN Stack: MongoDB, Express.js, React.js, Node.js for building the web application.

  • AWS S3: Amazon Simple Storage Service (S3) for storing media files securely.

Getting Started

Follow these steps to set up and run the project locally:

  1. Clone the repository to your local machine: 
    git clone https://github.com/Slacky300/WomenSafetyHackathonApp.git

Navigate to the project directory:

 cd BVP_HACKATHON

Install server dependencies:

  cd server
  npm install

Install client dependencies:

  cd ../client
  npm install

Set up AWS S3:

Create an AWS S3 bucket and configure access keys in your environment variables.

Configure the application:

Create a .env file in the server directory and configure environment variables such as database connection, AWS S3 credentials, and email settings.

Start the development server:

  cd ./server
  npm start

Start the client:

  cd ../client
  npm start

Access the application:

Open your web browser and navigate to: http://localhost:3000.

Usage

  • Users can register and log in to access the distress signal, incident reporting, and other features.
  • Admins can access the admin panel by visiting /admin and log in using admin credentials.