Git Product home page Git Product logo

unpaid-overtime-calc's Introduction

unpaid-overtime-calc

License: MIT

Description


This project will allow the user to enter the amount of hours worked in a day, which will then calculate the total unpaid hours across the course of a year.

This tool would mainly be used as a survery tool to register trends across different departments of employment, to give you an understanding of just how much extra time you work.

Table of Contents

Installation


If you wish to install the repo locally, please follow the instructions below. Otherwise you can veiw the calculator on the following link here.

Step 1 - Clone the github repo

Step 2 - Enter your details in the EXAMPLE .env file and save as .env

Step 3 - Right click the server.js file and Open in intergrated Terminal, and run npm i to install dependancies

Step 4 - Enter mysql -u <username> -p in terminal (this will open sql shell)

Step 5 - Enter your password

Step 6 - Enter source db/schema.sql, once this has run enter quit to exit the shell

Step 7 - Enter npm run seed to seed the test data into the database

Step 8 - Enter npm start to open the server connection

Step 9 - Open your browser and enter localhost:3001 to see the website in action.

Usage


Entry user will represent the survey participant, who will enter details regarding hours worked, employment department, email, id, and whether they took a lunch break. Once the calculate button is clicked, it will display the total overtime hours worked for the year, in addition to a comparison to others within the same department as reference point. This information is then stored within our database to further enhance the quality by increasing sample size.

Admin user has access to a login page with admin rights.

Screenshots:

The following images show the web application's appearance and functionality:

Entry Page where users can enter their details to calculate their unpaid overtime for a year

Screenshot showing Entry Page

Results Page showing the results for the user, as well as for all users to date, and also for others in the same industry.

Screenshot showing Results Page

Admin Results page showing what data an admin can view, and also the ability to download a csv file

Screenshot showing Admin Results Page

License


Licensed under MIT. For more information, visit this link. https://opensource.org/licenses/MIT

Questions


Please visit Unpaid Overtime

Name Email Github
Michelle Watts Email Michelle Michelle Watts Repo

unpaid-overtime-calc's People

Contributors

michellewatts20000 avatar catormerod avatar jbolton89 avatar jose109-001 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.