Skip to content
This repository was archived by the owner on Nov 8, 2018. It is now read-only.

Updated README.md #283

Open
fatimarafiqui wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Updated README.md #283

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f1c1d13
Updated Readme and linked it to wiki
fatimarafiqui Aug 30, 2017
aa8f8c0
updated abstract
fatimarafiqui Aug 30, 2017
6a0d2bc
added features to readme
fatimarafiqui Aug 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 14 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,17 @@
# 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. 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)
- [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)