Skip to content

Commit 1d9fd5d

Browse files
authored
Update README.md
cleaned up spelling
1 parent 900cad1 commit 1d9fd5d

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ Current Version: 1.0.0
1212

1313
Description:
1414

15-
This application suite was designed by volunteer fire fighters to enhance the experience of First Responders during an emergency 911 callout. The main goal of this application is to provide a free suite of applications which can help fire fighters receive timely information and communicate activities with one another as incidents progress. This software is currently in use by some firehalls in the Prince George, BC Canada, Regional District. For contact information see the contact section at the bottom of this page.
15+
This application suite was designed by volunteer fire fighters to enhance the experience of First Responders during an emergency 911 callout. The main goal of this application is to provide a free suite of applications which can help firefighters receive timely information and communicate activities with one another as incidents progress. This software is currently in use by some fire halls in the Prince George, BC Canada, Regional District. For contact information see the contact section at the bottom of this page.
1616

1717
Key Features:
1818
-------------
1919
- Real-time Email trigger (using Google App Engine) or email polling for 911 callouts received from your
2020
Fire Operations Command Center. Easily adaptable to other callout trigger mechanisms (such as Web, Rest API, SMS, etc).
21-
- Pluggable support for SMS gateway providers to send SMS information to fire fighters.
21+
- Pluggable support for SMS gateway providers to send SMS information to firefighters.
2222
Current SMS providers implemented include:
2323
- Twilio (twilio.com - paid account charges approx $0.0075 per SMS -> https://www.twilio.com/sms/pricing)
2424
- Plivo (plivo.com - paid account charges approx $0.0035 per SMS -> https://www.plivo.com/pricing/CA/#!sms)
@@ -31,12 +31,12 @@ Fire Operations Command Center. Easily adaptable to other callout trigger mechan
3131
- 'SMS command mode' allows SMS users to respond to calls (useful if radios don't work or data is unreliable)
3232
- Google Maps showing Distance from Firehall to Incident
3333
- Self Installation available (see videos below)
34-
- User Account management (LDAP support optional)
34+
- User Account Management (LDAP support optional)
3535
- Callout history with responding members
36-
- Google charts shows statistical view of data as well as monthly and annual member participation.
36+
- Google charts show a statistical view of data and monthly and annual member participation.
3737
- Customizable user interface using twig templates (http://twig.sensiolabs.org/)
3838
- Experimental Android App which integrates with the web application.
39-
- Great backup system during power outages at your firehall (if installed offsite / cloud), still get callouts via cell phone when radio backup battery system fails or has poor coverage.
39+
- Great backup system during power outages at your firehall (if installed offsite / cloud), but you still get callouts via cell phone when the radio backup battery system fails or has poor coverage.
4040
- Secure features such as optional two factor authentication (2FA) support, new device login detection and brute force attack detection help keep admin and users informed about suspcious activity.
4141

4242
Key Android App Features:
@@ -576,7 +576,7 @@ sudo apt-get install php7.1-curl
576576

577577
- If you get the following error in the logs and no sms message is sent:
578578

579-
Curl error: SSL certificate problem: self signed certificate in certificate chain
579+
Curl error: SSL certificate problem: self-signed certificate in certificate chain
580580

581581
- you must download: http://curl.haxx.se/ca/cacert.pem
582582

@@ -603,7 +603,7 @@ and the part to the right tells the webserver where to forward to, $1 copies url
603603
RedirectMatch 301 /rr(.*) https://svvfd.vsoft.solutions$1
604604

605605
Next create a custom sms twig file in the root folder where config.php exists, inside a new folder
606-
you wil lcreated named:
606+
you will create named:
607607

608608
views-custom
609609

@@ -620,15 +620,15 @@ https://vejvoda.com/rr/
620620
{% endblock %}
621621

622622
This will use the website: https://vejvoda.com/rr/ as a proxy to forward requests to: https://svvfd.vsoft.solutions
623-
which all phones would recognize because it uses the well known .com format
623+
which all phones would recognize because it uses the well-known .com format
624624

625625
Development:
626626
--------------
627627
Rip Runner uses composer for dependency management. Currently php 8.x is supported and our continuous integration system (Github actions) runs automated tests on those versions. If you want to contribute to rip runner as a developer checkout the repo from github and from the php folder of the repo on your local system run:
628628

629629
composer install
630630

631-
This will download all runtime and automated tests dependencies. If compser completed successfully you should be able to run the automated tests by running this command from the php folder:
631+
This will download all runtime and automated tests dependencies. If composer completed successfully you should be able to run the automated tests by running this command from the php folder:
632632

633633
phpunit
634634

@@ -641,11 +641,11 @@ Experimental Work:
641641

642642
Angular client:
643643
---------------
644-
We have begun porting the user interface to Angular (v8+). Currently this UI is partially ported from the
644+
We have begun porting the user interface to Angular (v8+). Currently, this UI is partially ported from the
645645
legacy twig UI, in order to build and deploy to your server:
646646

647647
- Install Node.js® and npm (https://nodejs.org/en/download/) if they are not already on your machine.
648-
- Install the Angular CLI globally, open a console prompt:
648+
- Install the Angular CLI globally, and open a console prompt:
649649

650650
npm install -g @angular/cli
651651

@@ -673,25 +673,22 @@ then copy the ngui folder to the root folder on svvfd.yourhost.com
673673

674674
Serverless support:
675675
-------------------
676-
We have started work on the application architecture to prepare for supporting various vendors who offer serverless computing platforms. Documentation can be read regarding deploying to Google Cloud Run (GCR) using a docker container
676+
We have started work on the application architecture to prepare to support various vendors who offer serverless computing platforms. Documentation can be read regarding deploying to Google Cloud Run (GCR) using a docker container
677677
https://github.com/softcoder/riprunner/tree/master/docker
678678

679679

680680
Contributions:
681681
--------------
682-
Special thanks to all who have contributed to the success of this project. We accept patches and ideas from others and priortize based on time constraints and compatibility with our future direction.
682+
Special thanks to all who have contributed to the success of this project. We accept patches and ideas from others and prioritize based on time constraints and compatibility with our future direction.
683683

684684
Contributors currently include:
685685
- The Salmon Valley Fire Hall for all the great testing and feedback
686686
- Dennis Lloyd (Officer at the Shell Glen Fire Hall) for peer review, and many contributions, without which
687-
we would have many more defecs and have a much less pleasing user interface.
687+
we would have many more defects and have a much less pleasing user interface.
688688

689689
Contact Info:
690690
--------------
691691
- Email: mark@vsoft.solutions
692-
- Slack Channel: https://join.slack.com/t/vsoftsolutions/shared_invite/enQtNzU1MzQzMTU2NDE3LTBiM2EyMGQ4ZWQwYTNmMzk0OTMzMDg4NWY0MDJiZTk4NTI5YTE5ODZjMGEzODM5YmNhODJhNDE2ODg1NTY1MGU
693-
- Join our IRC channel `#softhaus` on FreeNode.
694-
- Webchat IRC channel: http://webchat.freenode.net/?channels=softhaus
695692

696693
----
697694
Free Firehall Software Volunteer SMS Android Google App Engine Communications

0 commit comments

Comments
 (0)