Workday Planner

A single-workday planner that saves text inputs and also color codes by the hour depending on if the planner event is in the past, present or future as indicated by the colors: grey, red and green.

A deployed version can be viewed here.

Contents

1. About
   1. User Story
   2. Acceptance criteria
   3. Visuals
   4. Build
2. Setup
3. Credits
4. License
5. Contributing

About

A simple calendar application that allows the user to save events for each hour of the day. This app will run in the browser and feature dynamically updated HTML and CSS powered by jQuery.

User Story

AS AN employee with a busy schedule
I WANT to add important events to a daily planner
SO THAT I can manage my time effectively

Acceptance Criteria

GIVEN I am using a daily planner to create a schedule
WHEN I open the planner
THEN the current day is displayed at the top of the calendar
WHEN I scroll down
THEN I am presented with timeblocks for standard business hours
WHEN I view the timeblocks for that day
THEN each timeblock is color coded to indicate whether it is in the past, present, or future
WHEN I click into a timeblock
THEN I can enter an event
WHEN I click the save button for that timeblock
THEN the text for that event is saved in local storage
WHEN I refresh the page
THEN the saved events persist

Visuals:

Build

• In HTML semantic tags have been used to aid with accessibility.
• The site is built using Bootstrap as as a CSS framework.
  • The use of Bootstrap minimises the need for media queries.
  • See Bootstrap documentation for customizing the site with their provided options
• Google Fonts allows for the usage of custom fonts that do not have to be installed on the user's machine
• Font Awesome allows for the usage of custom icons
• jQuery powers the dynamic rendering of the html content based on user input
• moment.js is used to manipulate date values for historic data extraction from APIs

Setup

To clone the repo:

git clone [email protected]:jfisher396/workday-scheduler.git

Credits

James Fisher

License

Built by James Fisher. This application is released under MIT license.

Contributing

To contribute to this application, create a pull request. Here are the steps needed for doing that:

• Fork the repo
• Create a feature branch (git checkout -b NAME-HERE)
• Commit your new feature (git commit -m 'Add some feature')
• Push your branch (git push)
• Create a new Pull Request

Following a code review, your feature will be merged.

=======