Skip to content
API For TenFour
PHP HTML TSQL Shell Dockerfile JavaScript
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
app Copy from historical tenfour repo Jul 4, 2019
bootstrap Copy from historical tenfour repo Jul 4, 2019
config Copy from historical tenfour repo Jul 4, 2019
database Copy from historical tenfour repo Jul 4, 2019
docker Copy from historical tenfour repo Jul 4, 2019
docs Copy from historical tenfour repo Jul 4, 2019
public Copy from historical tenfour repo Jul 4, 2019
resources Copy from historical tenfour repo Jul 4, 2019
storage Copy from historical tenfour repo Jul 4, 2019
tests Copy from historical tenfour repo Jul 4, 2019
.editorconfig Dot fles Jul 4, 2019
.env.deploy Dot fles Jul 4, 2019
.env.docker.run Dot fles Jul 4, 2019
.env.example
.env.testing Dot fles Jul 4, 2019
.gitignore Dot fles Jul 4, 2019
CHANGELOG.md Copy from historical tenfour repo Jul 4, 2019
Dockerfile
Homestead.yaml Copy from historical tenfour repo Jul 4, 2019
LICENSE.txt LICENSE Jul 4, 2019
README.md Added labels + explanations Nov 10, 2019
Vagrantfile Copy from historical tenfour repo Jul 4, 2019
artisan Copy from historical tenfour repo Jul 4, 2019
codeception.yml Copy from historical tenfour repo Jul 4, 2019
codeship-services.yml Copy from historical tenfour repo Jul 4, 2019
codeship-steps.yml
composer.json Copy from historical tenfour repo Jul 4, 2019
composer.lock Copy from historical tenfour repo Jul 4, 2019
deployment.env.encrypted Copy from historical tenfour repo Jul 4, 2019
design-contributions.md Added more resource links! Nov 6, 2019
docker-compose.yml Copy from historical tenfour repo Jul 4, 2019
gulpfile.js Copy from historical tenfour repo Jul 4, 2019
package.json Copy from historical tenfour repo Jul 4, 2019
phpspec.yml Copy from historical tenfour repo Jul 4, 2019
phpunit.xml Copy from historical tenfour repo Jul 4, 2019
server.php Copy from historical tenfour repo Jul 4, 2019

README.md

What is TenFour?

TenFour is an emergency check-in application for teams that unites multiple communication channels: SMS, email, desktop, mobile and chat. It's a team check-in system that gets answers when you need them most.

Responses can be collected from anyone, anytime, anywhere by SMS, email, the TenFour app and slack so there is no device type dependency.

It can securely store team info with multiple points of contact, all synced securely via encrypted transport.

It will support multiple admin and user roles, so that your team only sees what you want.

Users can Add contacts to a group so one can check-in with multiple people with the push of a button.

TenFour has modules that work with telecom carriers around the world (SMS currently in US, UK, CA, KE).

View our TenFour product slides here

How to use TenFour

TenFour step by step

Make note of your URL (example: https://myorganisation.tenfour.org/) and the password associated with yoru URL/Account or store in a secure password vault.

An admin can login to the dashboard online or on their phone and easily send a message.

Authoring a message is easy, you just type in your question and select the answers you want back. Example: “There was just an earthquake in SF, are you ok?”

Users then receive messages from all different channels. They can respond, and their response is routed back to TenFour

You can then go back to the app and see the status of check-ins.

More info on how to use TenFour is included on the TenFour support page

Why do we need TenFour?

Crises are growing in the world.

In the last two decades, there has been an increase of human-made attacks globally, while the majority are concentrated in just a few countries, there were attacks in 106 countries in 2017. Though overall mortality is low from these attacks, from our experience, they still require tools to coordinate to maintain duty of care for your team.

Extreme weather related events are increasing quickly, causing significant economic damage and casualties. All science shows that these extreme events will only increase in the coming years.

Crises are a big deal for organizations, as in the US, even with a robust 1st responder and insurance ecosystem, 25% of small businesses don’t reopen, and it is worse elsewhere in the world where SMEs have lower insurance rates for their assets.

TenFour test case

We’ve tested this in real life with a handful of organizations, community projects, volunteer groups and field staff and we’ve already seen it has been absolutely necessary.

AkiraChix is one of our sister organizations in Kenya that teaches women in Nairobi’s slums how to code and places them into tech jobs. During the election in Kenya this last summer, violence broke out in the slums. The manager of AkiraChix immediately checked-in with her students over TenFour. The 25 girls texted, emailed and responded to check-in notifications. In just a matter of minutes, AkiraChix knew that their students were safe.

TenFour API

Get started

Official Documentation

Docs

Contributing Code

TenFour became Open Source in August 2019. It was previous a closed repository and not an Open Source tool due to SMS vendor information being tied to Ushahidi who built the tool over the last 4 years.

As such the process for contributing is a work in progress and will be updated here.

Labels and how to use them to find development/technical issues

back-end issues - Issues to do with TenFour's Back-end 'API' or 'Client'.

bug - An issue that is not functioning as expected or not in the 'ideal' way for a large part of the TenFour users.

devops - An issue that looks at the development operation of the feature/product as a whole. Could be server, connection, reliability based.

documentation - An issue that needs supporting documentation created and logged for the feature/issue.

duplicate - A label to flag that there is a duplicate or very similar issue to the one with this label and the two issues could potentiall be condensed into one.

enhancement - A label to show that the issue is an improvement on an existing feature.

epic - A label to indicate a collection of issues under one theme or type. This is called an 'epic'.

Feature: Check-In - An issue that looks at the TenFour check-ins screens/process.

Feature: Groups - An issue that looks at the TenFour groups screens/process.

Feature: Notifications - An issue that looks at the TenFour notifications screens/process.

Feature: Onboarding - An issue that looks at the TenFour onboarding screens/process.

Feature: People - An issue that looks at the TenFour people screens/process.

Feature: Profile - An issue that looks at the TenFour profile screens/process.

Feature: Settings - An issue that looks at the TenFour settings screens/process.

feature request - A request specifically come from a user of TenFour that does not alreayd exist in the product.

front-end - An issue which needs front-end development coding.

good first issue - An issue that is suspected to be a good first issue for a new contributor to TenFour.

grant requirement - An issue that is connected to a requirement detailed in a grant/funding proposal.

low priority - An issue that is not at all critical to the functioning/improvement of the product.

medium priority - An issue that is somewhat critical to the functioning/improvement of the product.

high priority - An issue that is very critical to the functioning/improvement of the product.

marketing - An issue for marketing materials and/or promotional materials for TenFour. Can include presentation templates, merchandise etc.

mobile - This is an issue which affects and/or is most important on mobile.

P0 - Unbreak now! - This is a critical issue for developer/s to fix as it stops TenFour from functioning as intended.

P1 - Immediate - This is an important but not critical issue for developer to fix. It make reduce TenFour from functioning as intended

P2 - Normal - An issue which will be useful but not critical to have in the product.

P1 - Low - An issue that is somewhat useful but not critical to have in the product.

P4 - Wishlist - An issue which is a very nice to have in the product.

PWA - An issue that is specific to the PWA or Progressive Web App.

QA by dev - An issue that needs quality assurance testing by someone with development/coding experience.

question - An issue which raises a question from the community.

Support - An issue that needs work from a support function like tutorials, guides, documentation or customer/user support.

Tech debt - An issue which is as a result of technical debt

TenFour.org - An issue that affects Tenfour.org website

wontfix - An issue that won't be looked at until further notice.

Contributing Design

The process to contribute design to TenFour is captured by Open Design, a project between Ushahidi, Adobe & Designit.

You can find details on how to contribute design to TenFour on the Design contribution page

Documentation on how to contribute design work will be added to a documentation environment specifically for TenFour but for now please see Ushahidi's design documentation on Gitbooks

Labels and how to use them to find design issues

Open Design issue - An issue that has been identified for an Open design workshop. These workshops bring together designers wanting to contribute in groups (or individuals) to issues in TenFour.

Design: Interaction - An issue which needs attention to how users interaction with it. Could be UI connected, voice, or gesture. Particularly useful for Human Computer Interaction/Design (HCI/D) people.

Design: UI - An issue which needs attention to the interface that users use. Can be a visual interface but also a conversation interface (voice) etc.

Design: Usability + Inclusion - An issue which needs attention to how users of all abilities and needs are considered. Inclusion and accessibility focus needed to inform how the feature functions.

Design: User Research - An issue which needs further user research done to fully discover and validate the problem/hypothesis presented in the issue.

Design: UX - An issue which needs attention on user experince of the feature or issue. Could be prototypes, flows, inclusion of other features, interactions and tasks that the user performs as part of this issue.

Design: Visual + Graphic - An issue which needs visual design and/or graphics. Could be to help communicate a feature visually with animations, supporting graphics and illustration or logo, colours and brand changes.

QA by Design - This is an issue that after having gone through development, needs a designer to approve the functionailty.

License

TenFour is under the license AGPL

You can’t perform that action at this time.