wsu-4110 / clockwise Goto Github PK

View Code? Open in Web Editor NEW

0.0 5.0 2.0 5.37 MB

Repository for Clockwise, a web-based application for productivity.

HTML 5.22% CSS 25.69% JavaScript 56.85% TypeScript 12.24%

clockwise's Introduction

Clockwise: CSC4110 Project!

Contributors:

Eisha Akbar, studying Computer Technology (Software Engineer)
Sadia Ahmed, studying Computer Science (Software Engineer)
Anabelle Ndrejaj, studying Computer Science (Lead Software Engineer)
Sidhant Bhandari, studying Computer Science (Software Engineer)
Adel Bazzi, studying Computer Science (Software Engineer)
Ojaswee Panthi, studying Computer Science (Software Engineer)

Clockwise version 1-- App Description

A web application which focuses on productivity, time management, and organization. It includes a variety of functionalities in one application, eliminating the need to use multiple applications.

Functionalities

Users will be able to create to-do lists.
Users will be able to use the daily habit tracker.
Users will receive motivational quotes/reminders as they prefer.
The user will have access to a journal/notes feature.
Users will be able to set reminders.
Users will be able to view the calendar history daily, monthly, etc.
Users will be able to add and delete events from the calendar.
Users will be able to add and delete habits from the habit tracker.
Users will be able to add and delete items from the daily check-in.

Tech Stacks

Software & Services	Purpose
React.js	UI Development
Node.js	Server Development
Mongo DB	Deployment

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

`yarn start`

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

`yarn test`

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

`yarn build`

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

clockwise's People

Contributors

Watchers

Forkers

adelbazzii sidizon

clockwise's Issues

FR8: Music API

FR8. Music API
Goal: Users will be able to customize aspects of the web app, such as timer sound and study music using a music API.
Stakeholders: Users
Description: Users can customize study music in the app to their liking via the Spotify API and maybe SoundCloud. For example, when users are studying or utilizing the focus timer they may prefer to have lo-fi music to help them focus that will be easily accessible through the web application.
Origin: This idea was discussed on 1/24/2022, based on the project proposal notes.
Version: 1.0
Date: 2/5/2022
Priority: 3

NR5: Easy to Edit

NR5: Easy to Edit
Goal: It will be straightforward to create, locate, and edit any input (writing, timers, etc.), and it will be easy to access output such as monthly calendar/habit tracker summaries.
Stakeholders: Developers
Description: The user inputs will be very straightforward and easy to navigate so when the user wants to add an event or do anything else, it can be done easily. It is the responsibility of the developers to guarantee easy input functions.
Origin: This idea was discussed on 2/1/2022, based on the project proposal.
Version: 1.0
Date: 02/05/2022
Priority: 1

NR3: Data Acquisition Transparency

NFR3. Data Acquisition Transparency
Goal: The user will be informed of all data that will be collected and have the option to opt out of any data not explicitly required.
Stakeholders: Users & Developers
Description: Users will be made aware of what data must be saved by the web app, like their login information, etc, so that the interaction between software and user is as open as possible. The user will also be able to opt out of data that they don’t want shared, like how apps allow users to choose “Ask app not to track” for any data that is not strictly necessary for the app to function. Developers are responsible for making the users aware of what data is being collected.
Origin: This idea came up on 02/02/2020, the day the group worked on functional requirements.
Version: 1.0
Date: 02/02/2022
Priority: 1

NR7: Web App Availability

NR7: Web App Availability
Goal: The web app will be available at all times of day, (99.99% availability)
Stakeholders: Developers and web app server
Description: When a user wants to access the web app, it will be available at all times of day, and all features will accommodate for all hours of the day, for example, the daily calendar will have all 24 hours as editable options. The web app will be reliable and always available.
Origin: Based on the notes for the project proposal and group assignment, the team came up with this requirement around the first meeting.
Version: 1.0
Date: 01/24/2022
Priority: 1

NR2: Saved User Data

NR2. User Data
Goal: The user’s data will be saved and will not be deleted erroneously.
Stakeholders: All
Description: When a user exits the website, their data will be automatically saved. The data will not be deleted unless the user deletes it themselves.
Origin: Based on the group assignment, the group members came up with the idea during the fourth meeting.
Version: 1.0
Date: 02/02/2022
Priority: 1

FR14: Delete daily check-ins

FR14. Users will be able to add and delete items from the daily check-in.
Goal: Users will be able to add and delete items from the daily check-in.
Stakeholders: Customers
Description:Users will be able to add or delete existing items from the daily check-in feature. On the off chance, the user wants to change an item, they will have the ability to delete or add new items.
Origin: During our fifth meeting, the group members decided to add this feature.
Version: 1.0
Date: 02/05/2022
Priority: 2

FR9: Journal Templates

FR9: Journal Templates
Goal: Users will be able to access several different templates within the journal feature.
Stakeholders: Users
Description: In the journal feature, users will be able to access templates such as to-do lists, notes, journaling, budget-making, grocery lists, etc. They will be able to make a variety of written documents based off of the templates.
Origin: This was discussed on 02/05/2022, based on meeting 5.
Version: 1.0
Date: 02/05/2022
Priority: 2

FR5: Reminders

FR5. Reminders
Goal: Users will be able to set reminders.
Stakeholders: Users
Description: Users will be able to set reminders at their desired times, and these reminders will also function for the tasks listed in the to-do list.
Origin: This idea was discussed on 1/24/2022, based on the project proposal notes.
Version: 1.0
Date: 02/05/2022
Priority: 1

FR10: User History Tracking

FR10. History
Goal: Users will be able to access daily check in and view their past daily, weekly, monthly, and yearly history.
Stakeholders: Users
Description: Users can access the daily check-in function and will be able to view all daily-check in history beginning from the first day they checked in, to present day. They will be able to switch between yearly view, monthly view, weekly view, and daily view.
Origin: 1/24/2022 based of the project proposal notes
Version: 1.0
Date: 2/5/2022
Priority: 3

FR3: Motivational Quotes

FR3. Motivational Quotes
Goal: Users will receive motivational quotes/reminders as they prefer.
Stakeholders: Users
Description: As the user prefers, the app will provide motivational quotes/reminders that are tailored to the users’ needs. If the user is using the application for organization, the quotes may be more motivational towards completing tasks and staying focused. On the other hand, if the user appears to be using the application for mental health purposes, the motivational quotes would be uplifting in nature and center around mental health. If the user is using the application for both reasons, they will receive a mix of different types of motivational quotes/reminders.
Origin: This idea was discussed on 01/24/2022, based on our initial group meeting.
Version: 1.0
Date: 02/03/2022
Priority: 1

FR11. Focus Timer History

FR12. Focus Timer History
Goal: Users will be able to access a history of their focus timer, the length used, past times used in a week, etc.
Stakeholders: Users
Description: Users will be able to view their history of the focus timer, and they will be able to see total hrs used in a day, week, month, or year, as well as the average length used and number of times they have used it. .
Version: 1.0
Date: 02/05/2022 based on the meeting notes.
Priority: 3

FR13: add/delete habits

FR1. Customers Greetings UI
Goal: Users will be able to add and delete habits from the habit tracker.
Stakeholders: Customers
Description: Users will be able to add or delete existing habits from the habit tracker feature. If the user would like to change a habit, there will be an option to delete or add new habits.
Origin:This idea was discussed on 01/24/2022, based on our initial group meeting.
Version: 1.0
Date:02/05/2022
Priority: 2

NR6: Performance Updates

NR6. Performance Updates
Goal: The web app will have no bugs and receive regular performance updates.
Stakeholders: Developers
Description: The website will go through constant website maintenance to ensure there are no bugs. If any bugs are found, the developers would work around the clock to resolve them.
Version: 1.0
Date: 02/02/2022
Priority: 2

FR7: Focus Timer

FR7: Focus Timer
Goal: Users will be able to access the focus timer and adjust the length of time to their needs.
Stakeholders: Users
Description: Users can access a focus timer that they can use to designate a specific amount of time they want to be solely dedicated to getting a certain task done. This timer can be adjusted to any specific length.
Origin: This idea was discussed on 01/24/2022, based on our initial group meeting.
Version: 1.0
Date: 02/05/2022
Priority: 1

NR4: Easy to Navigate

NFR4. The user will be able to navigate the web application easily, and will be able to access clear and succinct information if they have a question about how to use the web app.
Goal: The user will be informed of all data that will be collected and have the option to opt out of any data not explicitly required.
Stakeholders: Developers
Description: The website will be designed such that it can be easily navigated. If the user has a question about any features, they can refer to the User’s Manual. Developers are responsible for giving clear information regarding navigation of the app.
Origin: The group members came up with the idea during our fourth meeting.
Version: 1.0
Date: 02/02/2022
Priority: 1

FR6: Calendar and History

FR6. Calendar Feature
Goal: Users will be able to view the calendar history daily, monthly, etc.
Stakeholders: Users
Description: Users can access the calendar function and will be able to view all calendar history beginning from the first day they used the calendar, to present day. They will be able to switch between yearly view, monthly view, weekly view, and daily view.
Origin: This idea was discussed on 1/24/2022, based on the project proposal notes.
Version: 1.0
Date: 2/5/2022
Priority: 3

NR8: Webpage Response Time

FR12. Webpage Response Time
Goal: When the user clicks a link, the page will respond to the user’s input within 0.1 seconds.
Stakeholders: Web Server
Description: The user will be able to access all features quickly every time they use the web app, so that the web app will be convenient and reliable, and the user will not have to worry about a lag causing them to be unable to access features or their information.
Origin: This idea was brought up on 02/02/2020, based on the team google doc notes.
Version: 1.0
Date: 2/5/2022
Priority: 1

FR4: Journal/Notes Feature

FR4. Journal/Notes Feature
Goal: The user will be able to utilize the journal/notes feature. .
Stakeholders: Users
Description: Users have the ability to use the journaling feature on this application. The journal section can provide users with the ability to articulate their thoughts and feelings and reflect upon their mental health or daily experiences. If users want, they can also use the feature for jotting down notes that they may need to revisit or have written records of.
Origin: This idea was discussed on 1/24/2022, based on the project proposal notes.
Version: 1.0
Date: 2/5/2022
Priority: 1

FR1: Creating to-do lists

FR1. Creating to-do lists
Goal: Users will be able to create to-do lists.
Stakeholders: Users
Description: The users of this app are those who are in need of organization, thus they will be able to create to-do lists using the planner feature with the tasks they have to complete (daily, weekly, monthly, etc.
Origin: This idea was discussed on 01/24/2022, based on the project proposal notes. .
Version: 1.0
Date: 02/02/2022
Priority: 1

FR2: Daily Habit Tracker

FR2. Daily Habit Tracker
Goal: Users will be able to use the daily habit tracker.
Stakeholders: Users
Description:The daily habit tracker feature will enable users to ensure that they are meeting their daily self-care related needs. Sometimes school/work related tasks are not of utmost importance. For some, being able to complete things like getting out of bed in the morning, cleaning their room, eating three meals, or even taking necessary medicine are examples of habits that can be tracked.
Origin: This idea was discussed on 01/24/2022, based on the project proposal notes. .
Version: 1.0
Date: 02/02/22
Priority: 1

FR15. Google Login

FR15. able to login through Google
Goal: Users will be able to log in with their Google account.
Stakeholders: Customers
Description: The users will be able to log in and signup with their existing Google account, so it will be linked to their email.
Origin: The users will be able to login and signup with their existing google account, so it will be linked to their email.
Version: 1.0
Date: 02/05/2022
Priority: 1

FR12. Adding/Deleting events: Calendar

FR12. Adding/Deleting Events: Calendar
Goal: Users will be able to add and delete events from the calendar.
Stakeholders: Users
Description: Users will have the option to add and delete events in the calendar. If the user wants to change any event, they can delete it and add a new event.
Origin: The idea originated during our fifth meeting. .
Version: 1.0
Date: 02/05/2022
Priority: 2

NR1: User Data

NFR1. User Data
Goal: The website will protect user data and anyone other than the user will be unable to access the user’s account and information.
Stakeholders: Users
Description: When the user makes an account, no one will be able to gain access to their login information. Furthermore, no one other than the user will be able to access their personal data because it may contain some sensitive information.
Origin: We came up with the idea during our meeting on 2/2/2022
Version: 1.0
Date: 02/02/2022
Priority: 1