Skip to content

Latest commit

 

History

History
161 lines (119 loc) · 4.54 KB

README.md

File metadata and controls

161 lines (119 loc) · 4.54 KB
Raw

Rescue (Women Safety Website)

📧A women’s safety website that sends emails and messages to your trusted ones. 🚺

✨About the Project

RESCUE is a responsive website to help women through panic and unsafe situations.
A main feature of website is the Emergency Button.
If the person feels unsafe in any situtation, they can click on that emergency button and within no time an Alert Message will be sent to her Trusted Contacts with her Location Credentials that she is in need of help.

Our main aim is to help women with the support of latest technologies.

💻Technology Stack

Frontend

Backend

⚙Installation

Star the Repo 🌟 and this will keep me motivated.

  1. Download and install Python
  2. Download and install Git.
  3. Fork the Repository.
  4. Clone the repository to your local machine
git clone https://github.com/<your-github-username>/Rescue.git
  1. Change directory to main_app
cd main_app

6.. Install django and other requirements by using the command below.

pip install -r requirements.txt
  1. Fill the details in the files:
  1. Make migrations
python manage.py makemigrations
  1. Migrate the changes to the database
python manage.py migrate
  1. Create admin
python manage.py createsuperuser
  1. Run the server
python manage.py runserver
  1. View the website -
    • Click here
      OR
    • Paste the following in your browser 
      https://localhost:8000

Lint and Format 📜

We are using Flake8 and Black for linting & formatting source code of this project.

Run QA checks on local environment ⚡ :


  • For Windows 💾 :
...\rescue> .\rescue_QA_checks
  • For Linux 👨‍💻 :
.../rescue$ ./rescue_QA_checks
  • Alternate option ✔ Run the following commands ⚡:
    • For Windows 💾 
      ...\rescue> black .

      ...\rescue> flake8 .
    • For Linux 👨‍💻 
      .../rescue$ black .

      .../rescue$ flake8 .

First time to Open Source Love

Read How to Contribute.

✨Our Contributors

Thanks goes to these wonderful people (emoji key):

Code Of Conduct

You can find our Code of Conduct here.

📄License

MIT

Project Maintainer

Swapnil Sparsh