Skip to content

Subhashit2406/crime-shield

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🛡️ Crime Shield

Crime Shield is a comprehensive web platform designed to enhance community safety through real-time crime updates, anonymous reporting, and data-driven insights. This platform serves as a bridge between law enforcement agencies and the community, fostering a safer environment through transparency and active participation.

🌟 Features

  • Real-Time Crime Updates: Stay informed with live crime data from trusted law enforcement sources
  • Anonymous Crime Reporting: Report incidents securely without revealing your identity
  • State-wise Crime Analytics: Access detailed crime statistics and trends by state
  • Interactive Crime Database: Search and filter crime data with advanced filtering options
  • Community Engagement: Participate in creating a safer community through active involvement
  • Safety Tips & Resources: Access valuable safety information and prevention guidelines

🚀 Tech Stack

  • Frontend: HTML5, CSS3, JavaScript
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Authentication: JWT (JSON Web Tokens)
  • Icons: Font Awesome
  • Styling: Custom CSS with modern design principles

📋 Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v14.0.0 or higher)
  • MongoDB (v4.4.0 or higher)
  • npm (Node Package Manager)

🛠️ Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/crime-shield.git
    cd crime-shield
  2. Install dependencies:

    npm install
  3. Set up environment variables: Create a .env file in the root directory and add:

    MONGODB_URI=mongodb://localhost:27017/crimeshield
    PORT=3000
    JWT_SECRET=your_jwt_secret
    
  4. Start the server:

    node app.js
  5. Access the application: Open your browser and navigate to http://localhost:3000

📁 Project Structure

crime-shield/
├── public/              # Static files
│   ├── index.html      # Main landing page
│   ├── index.css       # Main stylesheet
│   └── ...             # Other static assets
├── routes/             # API routes
│   ├── reports.js      # Report handling routes
│   └── ...            # Other route files
├── models/             # Database models
│   └── Report.js       # Report model
├── app.js             # Main application file
├── package.json       # Project dependencies
└── README.md          # Project documentation

🔒 Security Features

  • Secure user authentication
  • Anonymous reporting system
  • Data encryption
  • Input validation
  • XSS protection
  • CSRF protection

🤝 Contributing

We welcome contributions to Crime Shield! Please follow these steps:

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

📝 Code of Conduct

Please read our Code of Conduct to keep our community approachable and respectable.

📄 License

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

👥 Authors

🙏 Acknowledgments

  • Law enforcement agencies for data collaboration
  • Open source community for tools and libraries
  • Contributors and maintainers

📞 Support

For support, email support@crimeshield.com or join our Slack channel.

🔄 Updates

Stay updated with our latest features and improvements by following our changelog.


⭐ Star this repository if you find it helpful!

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors