Project Two

Description

When We Clean allows hotel cleaning crew managers to easily manage their team's schedules in a simple, high powered web-based application.

Deployed Application

• Github Repository
• When We Clean Deployed App

Table of Contents

• Version History
• Installation
• Usage
• Contributing
• License
• Questions

Version History

Version 1.0:

• Create Manager Account
• Login/Logout of Manager Portal
• Manager Clock-In/Clock Out Time Card
• Manager Work Hours Logged
• Manager Update Profile and Change Password Capability
• View Current Employee Schedules via Dashboard Calendar
• Create New Employee Schedule
• Edit Employee Schedule
• Delete Employee Schedule

Installation

• Step 1: Install Node.js.
• Step 2: Clone this repository to your local drive.
• Step 3: Open Git Bash (PC) or Terminal (Mac) and navigate to the root directory of this cloned repository.
• Step 4: Enter npm i in the command line to install all dependencies detailed in the package.json file.
• Step 5: Copy the schema.sql code located in the db directory. Paste the schema code in MySQLWorkbench and execture it in order to create the required database structure for this application. Make sure to input your own unique MySQL user and password credentials in the config.json file located in the config directorty.
• Step 6: Enter node server.js or nodemon server.js in the terminal of your favorite coding editor and navigate to localhost:3000 in your browser of choice to invoke the application.

Usage

As a Manager, I want to view, create, delete, and update employee schedules so that I can organize my team more efficiently. I would also like to clock in and clock out of my shifts and view the hours that I have worked for the current week. This application uses the following technologies:

• HTML
• CSS
• Foundation
• JavaScript
• Node.js
• Handlebars.js
• Express.js
• MySQL
• Sequelize ORM
• Heroku

Contributing

Please ensure that your pull request adheres to the following guidelines:

• Alphabetize your entry.
• Search previous suggestions before making a new one, as yours may be a duplicate.
• Suggested README's should be beautiful and/or stand out in some way.
• Make an individual pull request for each suggestion.
• New categories, or improvements to the existing categorization are welcome.
• Keep descriptions short and simple, but descriptive.
• Start the description with a capital and end with a full stop/period.
• Check your spelling and grammar.
• Make sure your text editor is set to remove trailing whitespace.
• Use the #readme anchor for GitHub READMEs to link them directly

Thank you for your suggestions!

License

This project is MIT licensed.

Questions

For more information about this application, please feel free to contact a member of our development team.

Front End:

• Riley Costello
• Mychal Martinez

Back End:

• Rayna Veuleman
• Mike Bannoura