Skip to content
Safety Management System Project for Udacity
Branch: master
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.
__pycache__
static
templates
.gitignore
client_secrets.json
connect.py
database_populator.py
database_setup.py
functions.py
readme.md
simple_safety.py
test.py

readme.md

Safety Management System Project for Udacity Full-Stack Nanodegree Program

Author: Jonathan Prell

v1.1 - 9/15/2017


Changelog:

v1.1 - Added decorators to functions to check if:

  • User is logged in.
  • User is the author/owner of the item.
  • Item is created in the database.

About:

The Simple Safety Manager accomplishes the requirements of the Item Catalogue project and more. I decided to build this application in substitution of the original project to demonstrate my ability to build a corporate grade solution for a real world problem.

The application allows a user to capture incidents investigation details and compliance audit reports. The user may also track action items developed from the incidents cases or audit reports and tie them to those submissions or input an action item independantly.

All of the data can be read by anybody, but a user must log in to submit new information. A user may only edit or delete information they created.

Authentication is managed by a third party OAuth through Google.

The application takes advantage of a simple and free open weather API from Open Weather Map to prov-id-e the user current weather information. The weather currently prov-id-es local information for my location in Cincinnati, OH.


How to Use:

Any user may review the Incidents, Audits, or Action Items in the database.

To submit a case or report, the user must login.

Once the user is logged in, they may submit an incidents, Audit, or Action Item. These options will be available on the sidebar menu. All fields must be completed before the report can be submitted.

Action Items are automatically submitted and attached to an incidents Case or Audit. Individual Action Items related to safety may be submitted independantly. Once an Action Item has been completed, a logged in user may close the item.

Users may only edit Incidents, Audits, or Action Items they have submitted themselves.


API Endpoints:

API endpoints are available to prov-id-e JSON formatted data from the database.

  • /Incidents/json
    • Prov-id-es all items in the Incidents database.
  • /Incidents/json/-id-
    • Prov-id-es a specific item in the Incidents database by -id- number.
    • Replace -id- with the case -id- number.
  • /audits/json
    • Prov-id-es all items in the audits database.
  • /audits/json/-id-
    • Prov-id-es a specific item in the audits database by -id- number.
    • Replace -id- with the audit -id- number.
  • /actions/json
    • Prov-id-es all items in the actions database.
  • /actions/json/-id-
    • Prov-id-es a specific item in the actions database by -id- number.
    • Replace -id- with the actions -id- number.
  • /users/json
    • Prov-id-es all items in the users database.
  • /users/json/-id-
    • Prov-id-es a specific item in the users database by -id- number.
    • Replace -id- with the user -id- number.

Installation:

Prerequisite Programs:

Please run the following programs to set up the application on a vagrant virtual machine:

Installing the database:

Open postgres and run the following command:

CREATE DATABASE safety

Note: you may change the name of the database if necessary.

Open the connect.py file and update the username, password, and database name fields.

# Update the user and password for your database
user = 'yourusername'
password ='yourpassword'
database = 'safety'

In your vagrant VM please run the following command:

python database.py

Populating the database:

In your vagrant VM please run the following command:

python database_populator.py

Running the Safety Management System:

In your vagrant VM please run the following command:

python3 simple_safety.py

note: must run using python 3


Free online images used:

You can’t perform that action at this time.