Skip to content

Ankit-Basu/SheShield

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

32 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ›‘οΈ SheShield - Empowering Women Through Technology

SheShield Banner

Safety. Support. Empowerment.

Features β€’ Screenshots β€’ Tech Stack β€’ Installation β€’ Project Structure β€’ Security β€’ Roadmap

🌟 Project Overview

SheShield is a revolutionary women's safety platform that combines cutting-edge technology with community-driven support systems to create a safer world for women. In an era where safety concerns remain prevalent, SheShield stands as a digital guardian, providing immediate assistance during emergencies, preventive safety measures, and educational resources.

"Technology that protects, empowers, and transforms lives."

Built with a user-centric approach, SheShield focuses on accessibility, ease of use, and rapid response capabilities. Every feature has been designed with input from safety experts, women's rights advocates, and potential users to ensure it addresses real-world safety concerns effectively.

✨ Key Features

πŸ†˜ Emergency SOS System

  • One-click emergency alert system with location sharing
  • Immediate notification to emergency contacts and nearby authorities
  • Real-time tracking and status updates
  • Automated SMS and email alerts with GPS coordinates
  • Silent alarm options for discreet emergency signaling
  • Integration with local emergency services where available
  • Offline functionality to work even with limited connectivity

πŸ“ Incident Reporting

  • Secure and anonymous reporting system
  • Detailed incident documentation with media upload capabilities
  • Case tracking and follow-up mechanisms
  • Option to connect with legal advisors and support groups
  • Statistical analysis of incident patterns for preventive measures
  • Verification and moderation system to maintain data integrity
  • Integration with law enforcement reporting systems

πŸ‘£ Walk With Us

  • Request trusted volunteers to accompany you
  • Volunteer matching based on proximity and availability
  • Real-time tracking and safety check-ins
  • Volunteer verification and rating system
  • Scheduled walks with regular safety check points
  • Route optimization for safer pathways
  • Community guardian network with trained volunteers

πŸ’¬ AI-Powered Safety Assistant

  • 24/7 chatbot providing safety information and guidance
  • Contextual responses to safety queries
  • Legal resources and emotional support
  • Multi-language support for diverse user base
  • Personalized safety recommendations
  • Crisis de-escalation techniques and guidance
  • Continuous learning from user interactions to improve responses

πŸ—ΊοΈ Safe Spaces Mapping

  • Locate nearby safe spaces and women-friendly establishments
  • Community-verified safety ratings
  • Directions and contact information
  • Filtering options based on services offered
  • Accessibility information for inclusive safety
  • Operating hours and emergency accommodation details
  • Integration with transportation services for safe travel options

πŸ“Š User Dashboard

  • Personalized safety recommendations
  • Incident history and status tracking
  • Emergency contact management
  • Safety skill development tracking
  • Customizable alert thresholds and notification preferences
  • Community engagement and volunteer opportunities
  • Resource library with safety guides and educational content

πŸ’» Tech Stack

Frontend Backend APIs & Services
β€’ HTML5/CSS3
β€’ TailwindCSS
β€’ AlpineJS
β€’ JavaScript ES6+
β€’ Progressive Web App
β€’ PHP 7.4+
β€’ MySQL
β€’ RESTful API
β€’ MVC Architecture
β€’ Caching System
β€’ Geolocation API
β€’ PHPMailer
β€’ SMS Gateway
β€’ AI Chatbot
β€’ Cloud Storage

Security & Development

  • HTTPS encryption with modern cipher suites
  • Data anonymization and pseudonymization
  • Secure authentication with multi-factor options
  • Git version control with CI/CD pipeline
  • Docker containerization for consistent environments
  • Automated testing with PHPUnit and Jest

πŸ“± Application Screenshots

Homepage About Us

Emergency SOS Incident Reporting Walk With Us

AI Assistant Safe Spaces User Dashboard

Safety Resources Contact Page Settings

πŸ‘₯ Team

Our dedicated team consists of developers, designers, and safety advocates who are passionate about creating technology that makes a meaningful difference in women's lives. Each team member brings unique expertise and perspective to the project, united by the common goal of enhancing women's safety through innovative solutions.

The team regularly collaborates with women's rights organizations, safety experts, and community leaders to ensure that SheShield addresses real-world needs effectively.

πŸš€ Installation and Setup

Prerequisites

  • PHP 7.4 or higher
  • MySQL 5.7 or higher
  • Composer for PHP dependencies
  • Node.js (v14+) and npm for frontend dependencies
  • SSL certificate for secure HTTPS connections
  • SMTP server access for email functionality
  • SMS gateway API credentials
  • Geolocation API key

Installation Steps

  1. Clone the repository

    git clone https://github.com/yourusername/sheshield.git
    cd sheshield
  2. Install PHP dependencies

    composer install
  3. Install frontend dependencies

    npm install
  4. Configure the database

    • Create a MySQL database
    • Import the SQL schema from database_schema.sql
    • Copy config/email_config.example.php to config/email_config.php and update with your settings
    • Update database credentials in config.php
  5. Configure email settings

    • See EMAIL_SETUP.md for detailed instructions
    • Test email functionality with test_email.php
  6. Set up SMS gateway

    • Register with a supported SMS provider
    • Add API credentials to config/sms_config.php
    • Test SMS functionality with test_sms.php
  7. Configure geolocation services

    • Obtain API keys for mapping services
    • Update credentials in config/maps_config.php
    • Test location services with test_location.php
  8. Build frontend assets

    npm run build
  9. Set up proper file permissions

    chmod -R 755 .
    chmod -R 777 uploads/
    chmod -R 777 logs/
  10. Start the development server

    php -S localhost:8000
  11. Access the application at http://localhost:8000

  12. Run initial setup wizard

    php setup_database.php

Production Deployment

For production environments, additional steps are recommended:

  1. Use a proper web server (Apache, Nginx) instead of PHP's built-in server
  2. Set up HTTPS with a valid SSL certificate
  3. Configure server-level caching
  4. Set up a proper backup system
  5. Implement rate limiting and DDoS protection
  6. Configure server monitoring and alerting

πŸ“‹ Project Structure

SheShield/
β”œβ”€β”€ admin/               # Admin dashboard and management
β”‚   β”œβ”€β”€ dashboard.php    # Admin control panel
β”‚   β”œβ”€β”€ users.php        # User management
β”‚   └── reports.php      # Incident report management
β”œβ”€β”€ api/                 # RESTful API endpoints
β”‚   β”œβ”€β”€ auth/            # Authentication endpoints
β”‚   β”œβ”€β”€ incidents/       # Incident reporting endpoints
β”‚   β”œβ”€β”€ location/        # Location tracking endpoints
β”‚   └── walks/           # Walk With Us service endpoints
β”œβ”€β”€ auth/                # Authentication system
β”‚   β”œβ”€β”€ login.php        # User login
β”‚   β”œβ”€β”€ register.php     # User registration
β”‚   └── reset.php        # Password reset
β”œβ”€β”€ config/              # Configuration files
β”‚   β”œβ”€β”€ config.php       # Main configuration
β”‚   β”œβ”€β”€ email_config.php # Email settings
β”‚   └── db_config.php    # Database configuration
β”œβ”€β”€ css/                 # CSS stylesheets
β”œβ”€β”€ database/            # Database connection and queries
β”‚   β”œβ”€β”€ migrations/      # Database schema migrations
β”‚   └── seeds/           # Sample data for development
β”œβ”€β”€ emergency/           # Emergency response system
β”‚   β”œβ”€β”€ sos.php          # SOS alert handler
β”‚   └── notify.php       # Notification system
β”œβ”€β”€ escort/              # Walk With Us feature
β”‚   β”œβ”€β”€ request.php      # Walk request handling
β”‚   └── match.php        # Volunteer matching
β”œβ”€β”€ images/              # Static images
β”œβ”€β”€ includes/            # Reusable PHP components
β”‚   β”œβ”€β”€ header.php       # Page header
β”‚   β”œβ”€β”€ footer.php       # Page footer
β”‚   └── helpers.php      # Utility functions
β”œβ”€β”€ js/                  # JavaScript files
β”‚   β”œβ”€β”€ app.js           # Main application logic
β”‚   β”œβ”€β”€ map.js           # Mapping functionality
β”‚   └── chat.js          # Chatbot functionality
β”œβ”€β”€ location/            # Location tracking functionality
β”‚   β”œβ”€β”€ track.php        # Real-time tracking
β”‚   └── history.php      # Location history
β”œβ”€β”€ models/              # Data models
β”‚   β”œβ”€β”€ User.php         # User model
β”‚   β”œβ”€β”€ Incident.php     # Incident model
β”‚   └── SafeSpace.php    # Safe space model
β”œβ”€β”€ PHPMailer/           # Email functionality
β”œβ”€β”€ pro/                 # Frontend templates
β”‚   β”œβ”€β”€ index.html       # Homepage
β”‚   β”œβ”€β”€ aboutnew.html    # About page
β”‚   └── contact.html     # Contact page
β”œβ”€β”€ safespace/           # Safe spaces mapping
β”‚   β”œβ”€β”€ map.php          # Safe space map
β”‚   └── add.php          # Add new safe space
β”œβ”€β”€ screenshots/         # Application screenshots
β”œβ”€β”€ sql/                 # SQL scripts
β”‚   β”œβ”€β”€ schema.sql       # Database schema
β”‚   └── sample_data.sql  # Sample data
β”œβ”€β”€ uploads/             # User-uploaded content
β”‚   β”œβ”€β”€ incidents/       # Incident evidence
β”‚   └── profiles/        # User profile pictures
β”œβ”€β”€ utils/               # Utility functions
β”‚   β”œβ”€β”€ validation.php   # Input validation
β”‚   └── formatting.php   # Data formatting
β”œβ”€β”€ vendor/              # Composer dependencies
β”œβ”€β”€ .gitignore           # Git ignore file
β”œβ”€β”€ composer.json        # Composer configuration
β”œβ”€β”€ package.json         # npm configuration
β”œβ”€β”€ README.md            # Project documentation
└── index.php            # Application entry point

πŸ”’ Security Considerations

Data Protection

  • All user data is encrypted at rest and in transit
  • Personal information is stored with strict access controls
  • Location data is only shared during emergencies or with explicit consent
  • Data retention policies comply with legal requirements
  • Regular data purging for non-essential information

User Privacy

  • User information is anonymized in public reports
  • Opt-in approach for all tracking features
  • Granular privacy settings for user control
  • Transparent privacy policy with clear language
  • Right to be forgotten implementation

System Security

  • Regular security audits and vulnerability assessments
  • Penetration testing by third-party security experts
  • Input validation and sanitization to prevent injection attacks
  • Protection against common web vulnerabilities (XSS, CSRF, etc.)
  • Rate limiting to prevent brute force attacks
  • IP blocking for suspicious activity
  • Secure session management

Compliance

  • GDPR compliance for European users
  • CCPA compliance for California residents
  • Local data protection regulations adherence
  • Regular compliance audits and documentation
  • Data Processing Agreements with third-party services

🌟 Future Enhancements

Platform Expansion

  • Native mobile applications for iOS and Android
  • Wearable device integration for discreet emergency alerts
  • Voice assistant integration for hands-free operation
  • Offline mode with full functionality during connectivity issues

Feature Development

  • Integration with local law enforcement APIs
  • Advanced AI for threat detection and risk assessment
  • Behavioral analysis to identify potential threats
  • Augmented reality navigation to safe spaces
  • Community forums and support groups
  • Peer-to-peer safety networks

Technical Improvements

  • Blockchain-based incident verification system
  • Machine learning for pattern recognition in incident reports
  • Real-time language translation for global accessibility
  • Edge computing implementation for faster response times
  • Biometric authentication for enhanced security

Community Building

  • Safety ambassador program for community outreach
  • Safety certification for businesses and public spaces
  • Educational workshops and training programs
  • Partnership network with women's organizations
  • Public safety data sharing with researchers

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

🀝 Contributing

We welcome contributions from developers, designers, safety experts, and community advocates. Here's how you can contribute:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors