SOM-Timer / som_timer_fe

Som Timer: A timer that cares. Build in rest so you can focus best!

Home Page:https://som-timer.herokuapp.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Contributors Issues Issues

human head with arrows pointing to body

Som Timer

Som Timer is a timer that cares. Based on the Pomodoro technique™️, this application provides users with curated wellness content during break intervals. Build in rest, so you can focus best.

This application was created as our capstone project for the Front End Engineering program at the Turing School of Software & Design.

Som Timer won 2nd place at Turing's demo competition in November of 2020 as decided by a panel of industry judges and the Director of the Turing School.

Deployed Front End | Deployed Back End

Table of Contents

Installation Instructions

If you would like to install the repos locally instead of visiting the deployed sites, follow these directions:

  1. Clone down the Front End Repository by running git clone git@github.com:SOM-Timer/som_timer_fe.git <...> in the terminal, where <...> is an optional argument to customize the name of your local repo.
  2. Run npm install to install necessary dependencies
  3. Navigate to the root directory and run npm run start to view the app in action.

Project in Action

Timer Cycle Part 1

Users can set a timer for a focus interval and then be served wellness content from their selected category during breaks.

timer cycle 1

Timer Cycle Part 2

After the break content is complete, users return to the focus interval timer. Mood is also rated before and after the break content.

timer cycle 2

Mood Selection

When users visit our mood selection screen, they are met with a pleasing aesthetic and visual indications of their interaction with the form. Any time a face is clicked on, the others fade away a bit. If a user attempts to click the submit button without selecting a face, they receive a warning message.

mood selection

Changing Settings

Users can customize their focus and break intervals, as well as the audio clip that will be used to notify them when the focus interval has ended.

changing settings

Dynamic Timer Settings

On the main timer view, the heading will change based on whether the user has not yet begun the timer, it is playing, or if it is paused.

dynamic timer settings

404 Page

If users visit a url that does not exist, they receive a 404 message with helpful links to get back on track.

404 page

About Page

When users visit the About Page, they receive information about our application, the pomodoro technique, and the contributors.

About page

Tech Stack & External Libraries

Future Directions

This current version of the app is just the beginning, and we would like to significantly expand our scope. The following are our plans for future iterations:

Expand customization

  • We want to ensure that Som Timer works well for all users, so we would like to expand our customization options on the Settings page. Current ideas for this include adding the ability to toggle between themes, such as light and dark mode, and select the categories of content the user can then choose from during breaks.

Allow a user to upload content

  • In the vein of expanding customization, we would also like to give the user the ability to add new content to their personal library by uploading links from YouTube, Vimeo, SoundCloud, and other platforms.

Back End Information

Contributors

Front End Developers

Back End Developers

About

Som Timer: A timer that cares. Build in rest so you can focus best!

https://som-timer.herokuapp.com/


Languages

Language:JavaScript 84.3%Language:SCSS 14.2%Language:HTML 1.5%