safeFirst

This application is a resource that will assist contractors with administration of their Health and Safety in Employment (HSE) obligations.

The application will cover the following;

• Safety Meetings,
• Hazard Identification and Control,
• Daily Tailgate Meetings, and
• Near miss / Accident reporting

Team

Cameron - Product Owner
Robert
Richard

Timeline

Sprint	Days	Summary	Client Side	Server Side	Git Master	Agile Navigator
0	Wednesday/ Thursday	Planning	Boilerplate, create Components	Create DB Migrations and Seeds
1	Friday/ Saturday	Build structure	Build Components	Build Routes	Robert	Cameron
2	Sunday/ Monday	Finish MVP	Finalise build of Components	Make adjustments where needed	Richard	Robert
3	Tuesday/ Wednesday	Testing, CSS, Stretch	Testing React/Redux, Apply CSS and Design, Finishing touches, Stretches	Deploy, Testing	Cameron	Richard
4	Thursday	Prepare presentation

User Stories

MVP
Client wishes to use the digital application that will help improve administration of;

• Safety Meetings,
• Hazard Identification,
• Daily Pre-Start Meeting, and
• Incident/Accident reporting for the purpose of their HSE obligations.

Stretch

1. Link database to make it accessible to stakeholders for anaylsis and auditing purposes.
2. Have a feature that maps and can track the positioning of employees that are in a high risk situation or an isolated location.
3. Database that stores background information in pdf or jpeg format;

• Company policies
• Principal/Owner policies
• Location maps and accurate GPS points for high risk tasks
• The HSE Act 2015
• Industry based Code of Practice

Views (client side)

1. Landing, with login and register links/buttons in Nav bar.
2. Login - Form, username and password fields and submit button.
3. Register - Form, username and password creation, and email fields and submit button.
4. Dashboard - div showing the most significant hazards for that day. div thats shows graphs of incident and accident trends. Also has buttons for Safety Meeting Daily Pre-Start Meeting Incident / Accident.
5. Safety Meeting - Form with an add hazard button to show a new form field to fill for hazards that has arisen and submit button.
6. Daily Pre-Start Meeting - Form field with an add hazard button to show a new form field to fill for hazards that has arisen and submit button.
7. Incident / Accident - Form field and submit button.

Reducers (client side)

We will need reducers for displaying a list of Registered incidents on the Incident form page. The information will be take from the information the registered user has has given on the Incident form page. When we click Add button on Daily Meeting Page, we will need to be able to take a hazard from the hazards table by filtering . We will need to be able to control the authentication side in terms of Logging In or Registering. this will involve cases for login request, login success, login failure, register request and register failure.

Actions (client side)

We will need actions for adding hazards to the hazard identification for the H & S Safety Meeting Page. When will click on Add button on Daily Meeting Page, afer we have filtered information from Hazards table, it will be added to Daily Meeting Page. We will need actions for login logout and register. Login will have export functions for receivelogin, loginError andloginUser and also a function for requestlogin. logout will have an export function for logoutUser and functions for requestLogout and receiveLogout. Register wil have an export function for registerUserRequest.

API (client - server)

Method	Endpoint	Protected	Usage	Response
Post	/api/auth/login	Yes	Log In a User	The Users JWT Token
Post	/api/auth/register	Yes	Register a User	The Users JWT Token
Get	/api/dashboard	Yes	List of hazards relevant for the current day (daily set to true)	Array of Objects (object = Hazard)
Get	/api/dashboard	Yes	Statistics TBD	TBD
Get	/api/hsmeeting	Yes	List of hazards where 'daily' is set to 'false'	Array of Objects (object = hazard)
Post	/api/hsmeeting/hazard	Yes	Add a new hazard	The hazard that was added (as an object)
Post	/api/hsmeeting/minute	Yes	Add a new meeting minute	The minute that was added (as an object)
Get	/api/hsmeetinglist	Yes	List of meeting minutes	Array of Objects (object = meeting minute)
Post	/api/dailymeeting	Yes	Add a new hazard	The hazard that was added (as an object)
Post	/api/incidents	Yes	Add new incident	The incident that was added (as an object)
Get	/api/incidents	Yes	List of all incidents raised	Array of Objects (object = incident)

API Documentation

Method : POST Route : / API/AUTH/REGISTER

(body) - an object / if correct new user :

{"user_name":"OTHERbob",
"contact_details":"123 valley alley",
"email_address":"abc@gmail.com",
"password":"bob"
} 

Will return

{"message":"Authentication successful","token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJib2JCT0IiLCJpYXQiOjE1Mzc0ODM4MDMsImV4cCI6MTUzNzU3MDIwM30.UfxJJQ8b0ppekGycWMu6FydSb3RaW0i8couDx3bOwjc"}

(body) - an object /if user name exists :

{"user_name":"bob",
"contact_details":"123 valley alley",
"email_address":"abc@gmail.com",
"hash":"bob"
} 

Will return

{"message":"User Name Taken"}

/!\ only mandatory to habe a name a password as a string

{
"user_name":"OTTERbob",
"password":""
} 

Will return

{"message":"Authentication successful","token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJPVFRFUmJvYiIsImlhdCI6MTUzNzQ4NTEwOCwiZXhwIjoxNTM3NTcxNTA4fQ.g8J41Y5dZHMVSOY-_aJHRZUbVJfYOglUVRVjneFshxs"}

Method : POST Route : / API/AUTH/LOGIN

(body) - an object / if correct combinaison :

{"user_name":"bob",
"password":"krunk"
} 

Will return

{"message":"Authentication successful","token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJib2IiLCJpYXQiOjE1Mzc0ODQ4MTUsImV4cCI6MTUzNzU3MTIxNX0.wNY3GveyZIeBKwDVpJ3ulkYE_KQv-T4cnuQz4bAsCWw"}

(body) - an object / if incorrect password :

{"user_name":"bob",
"password":"bob"
} 

Will return

{"message":"Password is incorrect"}

(body) - an object / if incorrect name :

{"user_name":"maurice123",
"password":"krunk"
} 

Will return

{"message":"User does not exist"}

---

Method : GET Route : / API/DASHBOARD

(body)- - an array of objects

[
    {
        "id": 1,
        "hazard": "Lose items on ground",
        "risk": "Slipping or falling",
        "control": "Everyone is responsible to keep the floor tidy with no lose items floating aorund",
        "daily": "true"
    },
    {
        "id": 2,
        "hazard": "Working on ladders",
        "risk": "Falling of the ladder",
        "control": "Work in pairs with one person on the ground responsible for ladder safety",
        "daily": "true"
    },
]

Method : GET Route : / API/DASHBOARD

(body)- - an array of objects

[
    {
      TBD
    },
    {
      TBD
    },
]

Method : GET Route : / API/HSMEETING

(body)- - an array of objects

[
    {
        "id": 1,
        "hazard": "Sunburn",
        "risk": "We are working through summer, there is a risk of sunburn",
        "control": "Wear SPF50, hat, sunglasses and long sleeve clothing if needed",
        "daily": "false"
    },
    {
        "id": 2,
        "hazard": "Working near road",
        "risk": "Being run over by a vehicle",
        "control": "Setting up a traffic management plan and reminding everyone on a daily basis to act responsibly around traffic",
        "daily": "false"
    },
]

Method : POST Route : / API/HSMEETING

(body) - an object:

{"datetime":"2018-09-26 15:30",
"location":"22 Cuba Street, Wellington",
"issues": "The following issues were discussed: health and safety plan, incidents from the last month. This led to the following conclussions and actions points......"
} 

Method : POST Route : / API/HSMEETING

(body) - an object:

{
"hazard": "Sunburn",
"risk": "We are working through summer, there is a risk of sunburn",
"control": "Wear SPF50, hat, sunglasses and long sleeve clothing if needed",
"daily": "false"
} 

Method : POST Route : / API/DAILYMEETING

(body) - an object:

{
"hazard": "Sunburn",
"risk": "We are working through summer, there is a risk of sunburn",
"control": "Wear SPF50, hat, sunglasses and long sleeve clothing if needed",
"daily": "false"
} 

Method : POST Route : / API/INCIDENT

(body) - an object:

{
"user_id": "Sunburn",
"incident_type": "Near Miss",
"datetime": "2018-09-26 15:30",
"task": "Other",
"othertask": "Cutting a piece of wire",
"incident": "Knife slipped and went through glove, but didn't cut finger",
"otherincident": "",
"location": "22 Cuba Street, Wellington",
"firstaid": "false",
} 

Method : GET Route : / API/INCIDENT

(body)- - an array of objects

[
	{
	"id": 1,
	"user_id": "2",
	"incident_type": "Near Miss",
	"datetime": "2018-09-26 15:30",
	"task": "Other",
	"othertask": "Cutting a piece of wire",
	"incident": "Knife slipped and went through glove, but didn't cut finger",
	"otherincident": "",
	"location": "22 Cuba Street, Wellington",
	"firstaid": "false",
	}, 
	{
	"id": 1,
	"user_id": "5",
	"incident_type": "Near Miss",
	"datetime": "2018-09-26 15:30",
	"task": "Other",
	"othertask": "Cutting a piece of wire",
	"incident": "Knife slipped and went through glove, but didn't cut finger",
	"otherincident": "",
	"location": "22 Cuba Street, Wellington",
	"firstaid": "false",
	}, 
]

DB (server)

Users

Column Name	Data Type	Purpose
id	Integer	Unique identifier for each user
user_name	String	Name of user logging in
email_address	String	Email address of registered user
contact details	string	Contact details of registered user
hash	string	The hashed password of the registered user
company_id	integer	Secondary key to create a link to the Company table
industry_id	integer	Secondary key to create a link go the Industry table

Companies

Column Name	Data Type	Purpose
id	Integer	Unique identifier for each company
company	String	Name of company

Industries

Column Name	Data Type	Purpose
id	Integer	Unique identifier for each industry
industry	String	Unique identifier for each industry

Incidents

Column Name	Data Type	Purpose
id	Integer	Unique identifier for each user
user_id	integer	user_id of the person who is currently logged in
person_involved	string	the user who is involved in the incident, lookup to user table
incident_type	String	The type of incident, defined list: 'Near miss', 'Accident', 'Injury'
date_time	string	The date and time the incident took place (YYYY-MM-DD HH:MM)
task	string	The task performed when the incident occured (dropdown)
other_task	string	The task performed when the incident occured (free text field)
incident	string	Description of the incident (dropdown)
other_incident	string	Description of the incident (free text field)
location	string	Location of where the incident happened (free text field)
first_aid	string	Has first aid been administered 'true' or 'false'

Hazards

Column Name	Data Type	Purpose
id	Integer	Unique identifier for each user
hazard	String	Description of the hazard
risk	integer	Risk rating on a scale from 1 to 5 (where 5 is highest)
control	string	Description of what has been done to mitigate the risk
daily	string	Is this risk to appear on the dashboard for the risks of the day, 'true' or 'false'

Meetings

Column Name	Data Type	Purpose
id	Integer	Unique identifier for each user
date_time	string	The date and time the incident took place (YYYY-MM-DD HH:MM)
location	string	Location of where the meeting was held
issues	string	Text report of issues identified

Setup

Run the following commands in your terminal:

yarn install
yarn knex migrate:latest
yarn knex seed:run
mv .env_example .env

To run in development:

yarn dev
 - or -
npm run dev

To run in production:

yarn start
  - or -
npm start