Rakshak is an all-in-one safety application designed to provide real-time updates on accidents, floods, and other hazards. With its intuitive design, it offers:
- Responsive dashboards for police and ambulance services.
- Interactive maps with heatmaps highlighting various hazard-prone areas.
- User-friendly reporting system to enable individuals to report incidents seamlessly.
Follow these steps to set up Rakshak on your local machine:
- Navigate to the backend directory:
cd backend - Create and activate a virtual environment:
python3 -m venv venv source venv/bin/activate - Install the required dependencies:
pip install -r requirements.txt
-
Move to the frontend directory:
cd .. cd frontend
-
Install the necessary packages:
npm install
-
Start the development server:
npm run dev
-
Open your browser and visit:
http://localhost:3000
We welcome contributions to make Rakshak even better! Here's how you can get involved:
- Fork the repository and clone it locally.
- Create a new branch for your feature or bug fix:
git checkout -b feature-name
- Make your changes and commit them with descriptive messages:
git commit -m "Add feature or fix description" - Push your branch to your fork:
git push origin feature-name
- Open a pull request detailing your changes.
Need help? Feel free to open an issue with your questions or ideas.
This project is licensed under the MIT License. For more details, check the LICENSE file.
Thank you for your interest in improving Rakshak! Together, we can make safety accessible to everyone.