From f1c1d13af929fa005a931f19f3517fc807568c35 Mon Sep 17 00:00:00 2001 From: Fatima Rafiqui Date: Wed, 30 Aug 2017 14:57:22 +0530 Subject: [PATCH 1/3] Updated Readme and linked it to wiki --- README.md | 40 ++++++++-------------------------------- 1 file changed, 8 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 0d1a26d..1bb6f18 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,11 @@ # FirstAide-Web [![Build Status](https://travis-ci.org/systers/FirstAide-web.svg?branch=develop)](https://travis-ci.org/systers/FirstAide-web) ### Abstract -Sexual assault and rape are serious social and public health issues, being one of the major cause of concern. -FirstAide-Web is a web based application developed to help the PCV(Peace Corps Volunteers), in case of sexual -harassment. The app ensures safety by sending messages to fellow volunteers, helpline numbers etc. when in trouble. This application makes it a point that the victim can be sure of getting all the help -he/she needs in case of a critical situation. The sexually assaulted volunteer can get information of Peace Corps policy and safety procedures and also contact Peace Corps for help. - - -### Rules for Contributing -1. To fix a new issue and submit a PR, the first step is to report the issue and get it approved by repo owners. -2. Before submitting an issue, make sure it is not already reported by someone else. You can check [here](https://github.com/systers/FirstAide-web/issues) in both open and closed categories -3. Before picking and working on an issue, make sure it is not already assigned to another developer. The protocol followed is that the issue is assigned to the developer who reports it first. -4. To suggest features that you think will enhance the app, please email us. -5. When you submit a PR please ensure that commit messages are meaningful and reflect what the PR fixes. -6. When you submit a PR for an issue, ensure that there is description of what the PR fixes, a link to the issue that you are fixing and tag the repo owners for review. - - -### Initial Setup and Installation -Download XAMPP from here [XAMPP download](https://www.apachefriends.org/download.html). You will also need a text editor. - -Go to your terminal and execute this command - -`$ git clone https://github.com/systers/FirstAide-web` - -Or download the ZIP file from above - -### Opening and Running -1. Launch XAMPP by opening XAMPP control panel -2. Start 'Apache' and 'MySQL' -3. Check if XAMPP has started using the url 'http://localhost:8080/' (Here 8080 is the port number, use the one which you have configured) -4. Now extract the ZIP file of the project FirstAide-web which you have downloaded and paste it in the C:\xampp\htdocs (the path where your xampp is present) -5. Open the file which you want to work with using a text editor. -6. Make the required changes and save the file -7. Now, view your changes using the url http://localhost:8080/directory_name/file_name.extension Example: 'http://localhost:8080/FirstAide-web/login.html' +Sexual assault and rape are serious social and public health issues, being one of the major cause of concern. FirstAide-Web is a web based application developed to help the PCV(Peace Corps Volunteers), in case of sexual harassment. National surveys by the United Nations estimate that one in every six women has experienced an attempt to rape at some time or the other. The vast majority of women are sexually assaulted by men with whom they are acquainted. Women are far less likely to report a rape or assault when they know their assailant, thus instance of sexual assaults are greatly under-reported. The FirstAide web app ensures safety by sending messages to fellow volunteers, helpline numbers etc. when in trouble. This application makes it a point that the victim can be sure of getting all the help he/she needs in case of a critical situation. The sexually assaulted volunteer can get information of Peace Corps policy and safety procedures and also contact Peace Corps for help. + +### Wiki +- [Home](https://github.com/systers/FirstAide-web/wiki) +- [Contribution Guidelines](https://github.com/systers/FirstAide-web/wiki/Contribution-Guidelines) +- [Gettting Started](https://github.com/systers/FirstAide-web/wiki/Getting-Started) +- [Import Database and Setup Configuration](https://github.com/systers/FirstAide-web/wiki/Importing-Database-and-Setup-Configuration) +- [Guidelines for writing Unit tests](https://github.com/systers/FirstAide-web/wiki/Unit-Tests-Guidelines) From aa8f8c0949d52265ad20837f2a24a6d0693ae533 Mon Sep 17 00:00:00 2001 From: fatimarafiqui Date: Wed, 30 Aug 2017 21:31:53 +0530 Subject: [PATCH 2/3] updated abstract --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1bb6f18..8bc2370 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # FirstAide-Web [![Build Status](https://travis-ci.org/systers/FirstAide-web.svg?branch=develop)](https://travis-ci.org/systers/FirstAide-web) ### Abstract -Sexual assault and rape are serious social and public health issues, being one of the major cause of concern. FirstAide-Web is a web based application developed to help the PCV(Peace Corps Volunteers), in case of sexual harassment. National surveys by the United Nations estimate that one in every six women has experienced an attempt to rape at some time or the other. The vast majority of women are sexually assaulted by men with whom they are acquainted. Women are far less likely to report a rape or assault when they know their assailant, thus instance of sexual assaults are greatly under-reported. The FirstAide web app ensures safety by sending messages to fellow volunteers, helpline numbers etc. when in trouble. This application makes it a point that the victim can be sure of getting all the help he/she needs in case of a critical situation. The sexually assaulted volunteer can get information of Peace Corps policy and safety procedures and also contact Peace Corps for help. +Sexual assault and rape are serious social and public health issues, being one of the major cause of concern. FirstAide-Web is a web based application developed to help the PCV(Peace Corps Volunteers), in case of sexual harassment. National surveys by the United Nations estimate that one in every six women has experienced an attempt to rape at some time or the other. The vast majority of women are sexually assaulted by men with whom they are acquainted. Women are far less likely to report a rape or assault when they know their assailant, thus instance of sexual assaults are greatly under-reported. The FirstAide web app ensures safety by sending messages to fellow volunteers, helpline numbers etc. when in trouble. This application makes it a point that the victim can be sure of getting all the help he/she needs in case of a critical situation. The sexually assaulted volunteer can get information of Peace Corps policy and safety procedures and also contact Peace Corps for help.FirstAide is an application which helps the victims of Sexual Assault. The project will be useful for the Peace Corps Volunteers and 'Systers' is developing it for them. The peace corps volunteers are constantly at the peril as they travel individually to many remote areas. This app comes to the rescue if they sense any trouble. There is a provision to send emergency messages to their comrades in one click. The volunteer can be prepared to handle any unwanted situation using the app. However, if the unfortunate happens then, the victim can be sure to get all the help needed. The helplines can be called directly using the call and SMS feature and the doubts can be cleared if any. There is also information provided regarding the safety and reporting procedures. ### Wiki - [Home](https://github.com/systers/FirstAide-web/wiki) From 6a0d2bc36e66502461081f57b2d5cf3603d65131 Mon Sep 17 00:00:00 2001 From: fatimarafiqui Date: Wed, 30 Aug 2017 23:39:41 +0530 Subject: [PATCH 3/3] added features to readme --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8bc2370..2c6b2e4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ # FirstAide-Web [![Build Status](https://travis-ci.org/systers/FirstAide-web.svg?branch=develop)](https://travis-ci.org/systers/FirstAide-web) ### Abstract -Sexual assault and rape are serious social and public health issues, being one of the major cause of concern. FirstAide-Web is a web based application developed to help the PCV(Peace Corps Volunteers), in case of sexual harassment. National surveys by the United Nations estimate that one in every six women has experienced an attempt to rape at some time or the other. The vast majority of women are sexually assaulted by men with whom they are acquainted. Women are far less likely to report a rape or assault when they know their assailant, thus instance of sexual assaults are greatly under-reported. The FirstAide web app ensures safety by sending messages to fellow volunteers, helpline numbers etc. when in trouble. This application makes it a point that the victim can be sure of getting all the help he/she needs in case of a critical situation. The sexually assaulted volunteer can get information of Peace Corps policy and safety procedures and also contact Peace Corps for help.FirstAide is an application which helps the victims of Sexual Assault. The project will be useful for the Peace Corps Volunteers and 'Systers' is developing it for them. The peace corps volunteers are constantly at the peril as they travel individually to many remote areas. This app comes to the rescue if they sense any trouble. There is a provision to send emergency messages to their comrades in one click. The volunteer can be prepared to handle any unwanted situation using the app. However, if the unfortunate happens then, the victim can be sure to get all the help needed. The helplines can be called directly using the call and SMS feature and the doubts can be cleared if any. There is also information provided regarding the safety and reporting procedures. +Sexual assault and rape are serious social and public health issues. FirstAide is a web based application developed to help the PCV(Peace Corps Volunteers), in case of sexual harassment. A vast majority of women is sexually assaulted by men with whom they are acquainted. Women are less likely to report a rape or assault when they know their assailant, thus instance of sexual assaults are greatly under-reported. The FirstAide web app ensures safety by sending messages to fellow volunteers, helpline numbers when in trouble. This application makes sure that a victim would get all the help he/she needs in case of a critical situation. The sexually assaulted volunteer can get information of Peace Corps policy and safety procedures and also contact Peace Corps for help.FirstAide is an application which helps the victims of Sexual Assault. The project will be useful for the Peace Corps Volunteers and 'Systers' is developing it for them. The Peace Corps volunteers are constantly at the peril as they travel individually to many remote areas. +- Circle of Trust: There is a provision to send emergency messages to their comrades in one click. +- Sexual Assault Awareness: The volunteer can be prepared to handle any unwanted situation using the information available on the application +- Get Help Now: The helplines can be called directly using the call and SMS feature and the doubts can be cleared if any. +- Safety Tools and Guidelines: There is also information provided regarding the safety and reporting procedures. +- User Account Settings: The user can update their personal information through the account settings section. + ### Wiki - [Home](https://github.com/systers/FirstAide-web/wiki)