swapnilsparsh/rescue

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

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

5. Change directory to main_app

cd main_app

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

pip install -r requirements.txt

4. Fill the details in the files:

• main_app/mail.py

• mysite/settings.py

5. Make migrations

python manage.py makemigrations

6. Migrate the changes to the database

python manage.py migrate

7. Create admin

python manage.py createsuperuser

8. Run the server

python manage.py runserver

9. 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

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

Project Maintainer

Swapnil Srivastava

Utkarsh Mall

Utkarsh Sharma

rescue's Issues

GIF which is on the homepage, make it responsive

Fix the login page text while checking responsive

Improving update contact option

The update contact field doesn't show the data in the corresponding fields. It pops up like a add contact form. I want to show the data on existing fields as well. User may want to update a specific field.

Fix the Carousel speed

addition of website preloader

Is your feature request related to a problem? Please describe.

• A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
  Yes
  Describe the solution you'd like

---

• A clear and concise description of what you want to happen.
  I want to add a website preloader that will give a nice animation for the time the website loads
  Describe alternatives you've considered

---

• A clear and concise description of any alternative solutions or features you've considered.

Additional context

• Add any other context or screenshots about the feature request here.

The toggle button is not working fine

toggle button is not toggling properly when I click on it its just goes up and the again comes down

On home page when clicking on more than dropdown menu is not opening

Improve the Footer

.gitignore file

We can add a .gitignore file for the project so that changes in unnecessary files are not tracked in git like pycache, the database file-db.sqlite3 etc.
(work for DWOC)

Fix the GIF going under the Navbar in small screen

Add Contributors.md file

Hai,
I would like to add Contributors.md file in your project in the form of a table and display a link to it in README.md

Add a feature that alert message should go on saved phone number

Add Contributing.md file as well as update the readme file

Hii @swapnilsparsh,
I would like to work on contributing.md as well as updating the present readme file by adding some cool elements which look amazing or gives a cool/nice look.
Hope you like it!
Thankyou in advance

Show the contributors name on README.md file

Show the CONTRIBUTORS.md table on README.md or make a new table.
For reference you can have a look.

Change the UI of carousel and make it responsive which is on the home page.

Improve the Documentation of Women Helpline Numbers Section

404 error - Page not found

Is your feature request related to a problem? Please describe.

Adding 404 error page - page not found for the links that are not existing.

Fix the Navbar

While checking is it responsive or not there is a bug which you have to fix.

After logging in the dashboard's header does not have proper orientation

FIx the footer

On some pages footer is not working properly

On some pages its working fine so
you have to make the footer look like this on every page.

Create Code of Conduct. md

Hi,
I found that this project repository is not having a code of conduct file in this repository, kindly assign me this issue and I would like to contribute a well-formatted code of conduct file as you know code of conduct is a necessary file which the contributors need to follow so that everyone follows a decorum.

Improving UI of women laws, women rights and helpline number pages

Is your feature request related to a problem? Please describe.

Modifying the user interface of the three pages - women's laws, women's rights, and helpline number.

Footer Bug

When clicking on footer helpline number then developer page is opening which should be fix.

Fix the typo error at Login Page.

Integrate welcome bot

I can add a welcome bot config file having a proper message that will show up when any user will open up an issue or pull-request for the first time.
For reference, check out: https://github.com/apps/welcome

If you feel this is a great idea!
Please assign it to me.

Improving UI of login and sign up pages (Register and Login page)

Is your feature request related to a problem? Please describe.

• The Ui is not pleasing and can be made better.

Describe the solution you'd like

• Make a better design of UI.

Add a bot to moderate the issue request and the feature request

Is your feature request related to a problem? Please describe.
This bot would help a first time contributor so that that contributor can follow this project's contribution guidelines.We can link our issue template, pull request template and code of conduct here.It will contain newIssue Welcome comment, newPR Welcome comment, firstPR welcome comment,etc.

We can use a GitHub App built with probot that welcomes new users when they open their first issue. You can use this welcome message to provide links to resources like the contributing guidelines, code of conduct, etc. It should be located in a .github/config.yml

Demo 1

Demo 2

On clicking emergency contact error is showing

Improving Carousal

I want to improve the design of carousal in homepage. Please assign me the task and label it for Dwoc

Issue with the landing page and other pages before logging in as user

when someone directly hops into the margin page and after that opens-up other pages then some text are covered/not visible of the other pages

Now you can see those top sections like "welcome" part is clearly visible and also corrected all other landing pages before the signup those were showing the same issue @swapnilsparsh

Make the following pages responsive.

Make these page responsive -

1. helpline_numbers.html
2. women_laws.html
3. women_rights.html

Improve the Documentation of Women's Safety Laws Section

Typo Error / Bug in Contributing file

@swapnilsparsh there is a typo error / bug in the contributing file , the link to code of conduct file is redirected to some other's repository which actually is a forked repository of this project.
kindly assign me this issue
the below shown is the image of contributing file

and this is repo where it is redirected to when we click on code of conduct link

FIx the Emergency option

When no contacts is saved then on clicking the Emergency option it should redirect you to Emergency Contacts page.

/emergency/ is not showing all contacts

/emergency_contact/ is showing all the saved contacts, but /emergency/ is not showing any at first. I think it's another bug. Can you please assign that task to me? Label it for DWoC.

Improve the Documentation of Women's Rights Section

Documentation of Women Helpline Numbers Section

Hello,still the information and contact details regarding few other states is missing.

This website is not perfectly responsive a lot of bugs are there

Hey, if you want to make it responsive let me know

Make the Navbar Responsive

Add a GitHub action to auto-assign Mentors for every PR

I would like to add a GitHub action to auto-assign mentors for every PR. It sometimes becomes hectic for the mentors to take a look at all the Projects for the PRs made by the Contributors. This action would give a nice notification about reviewing the pr and make things pretty easy for the mentor. It would automatically ask for reviews by the mentors on every pr created.

Demo :

FIx the Register page footer

Developer Page - Improve the UI and Make it Responsive too

Fix the gif at home page

Gif which is available on home page is streching while checking responsive.

The pages start before the navbar, and hence the top content is cropped out.

Describe the bug

The content at the top is right now being overlapped with the navbar.

Expected behavior

• The pages should begin from a little below from what they're now.

Possible solution

Setting the margin-top for the pages.
Screenshots

Update readme.md

Add Contributing file

@swapnilsparsh Can we add a CONTRIBUTING.md file for contributors which would make it clear on how to contribute to the project

Issue and PR templates.

Issue and PR templates are missing.
I can do it. Please assign this to me. @swapnilsparsh

Fix the register page text while checking responsive

Documentation of Women Helpline Numbers Section (Add the left out States)

Make the Website Responsive