elhagen13 / StudyWell

1 stars 0 forks source link

StudyWell

StudyWell is a website designed to help people work for longer periods by implementing the Pomodoro Technique. The Pomodoro Technique is comprised of focused work sessions, short breaks, and long breaks that a user alternates between while working on a to-do list. Some features that our website has are a To-Do list, a tracker of how many Pomodoro sessions one has had, a short break feature, and a long break page. Users may check off items on their to-do list and delete them entirely. The site features a minimalistic design to minimize distraction and purely have the user focus on the task at hand.

Links for Details: Link to UI prototype (last updated 12/4/2023): https://www.figma.com/file/HA3SOczavqYtmhVWPkRV2t/Study-Well?type=design&node-id=0%3A1&mode=design&t=NoiOT9ULJP02yOoV-1 Link to wiki page (last updated 12/6/2023): https://github.com/elhagen13/StudyWell/wiki

Development environment set up: 1). Clone repository from GitHub -CI/CD and Azure testing will be automatically linked to any code you push 2). Download the Prettier extension to format code 3). Run npm install at the top level of the code 4). Place all node_modules in a .gitignore file

Contributing: 1). All members of the team use the Prettier code formatter extension. -Installation: All members can install the extension using VS Code's extension library. 2). The style guide is followed by Prettier's auto formatter some of these standards include : -Proper spacing after function definitions -Proper indentation -Line wrapping 3). Additionally, members should comment a description above each function stating its use