cornell-dti / samwise

A Student Planner for Everyone

Samwise

Last updated 05/09/2020

Contents

• About
• Getting Started
  • Contributing
• Dependencies & Libraries
  • Frontend
• Documentation
• Screenshots
• Contributors
  • Since 2016
  • Since 2017
  • Since 2018
  • Since 2019
  • Since 2020

About

A web app to help Cornell students plan their semesters.

Getting Started

You will need Node.js and Yarn installed on your development machine.

To setup your environment, go into the root folder and run yarn. Then, run yarn workspace frontend start to start a development server for frontend. If you need to work on firebase functions, run yarn workspace functions build to compile your functions code.

This repository comes with multiple tools to ensure code quality, including a linter and a type checker. Please ensure that they are properly configured with your IDE or text editor. For text editor setup instructions, please visit Cornell DTI's developer website.

Contributing

To maintain code quality, the master branch is write-protected. To contribute, please work on your changes in a new branch and then create a pull request into master. When opening a pull request, make sure you follow the pull request template. Better changelogs make the review process go quicker and easier for everyone.

All contributed code is expect to follow the Style Guide.

Dependencies & Libraries

Frontend

These should be installed automatically by yarn install.

• React - a Facebook library for frontend, used for frontend UI.
• Redux - a predictable state container for JavaScript apps, used for state management.
• React-Redux - a library with bindings between React and Redux.
• Firebase - a serverless service for authentication, database, analytics, and more.
• React FirebaseUI - a simple sign-in component library for Firebase Authentication.
• React Calendar - a calendar component for React.
• React Color - a collection of React components for picking colors.
• Fuse.js - a client-side fuzzy-search library.
• React Toastify - a library for emitting toasts in React.
• React Confetti DOM - a library for triggering confetti blasts
• React Modal - a library for displaying accessible modal dialog components
• React Beautiful DND - a library for drag and drop lists

To find the specific version used of each dependency, see package.json.

Documentation

Check our wiki to see all our documentation.

Screenshots

Contributors

Since 2016

• Alice Zhou* - Product Manager
• Justin Tran* - Front-end Developer
• Kevin Li* - Back-end Developer / Designer

Since 2017

• Gautam Mekkat* - Back-end Developer
• Matthew Epstein - Product Manager
• Vivian Shiu - Designer / Design Lead

Since 2018

• Jessica Hong* - Back-end Developer
• Michael Xing - Front-end Developer / Technical Product Manager
• Michelle Park - Designer
• Sam Zhou - Front-end Developer / Developer Lead

Since 2019

• Megan Yin - Front-end Developer
• William Evans* - Back-end Developer
• Pinxuan Huang - Front-end Developer
• Peter Wu - Front-end Developer
• Jason Tung - Back-end Developer

Since 2020

• Ishika Jain - Front-end Developer

* Former Contributor

We are a team within the Cornell Design & Tech Initiative. For more information, see our website.

samwise's Issues

Restrict Firebase Auth to Cornell Email

We can see the instructions here:
https://groups.google.com/forum/#!topic/firebase-talk/Xxm_rS4TWos

Can't edit tasks in biweekly view/monthly view

Exam importing does not include essay due dates.

Cornell posts the final essay/project due dates along with final exam dates. It would be helpful if these were included in the import feature.

Inconsistency in naming props

[For DevSesh 11]

I noticed in some classes like TaskView.jsx you just say Props and State when declaring (which is a bit unspecific), but then sometimes you name the Props struct something different like in ProgressIndicator.jsx. I prefer the second way, but it was just something I noticed.

Things break when the window is too small

Describe the bug
See the screenshot.
I don't think it's a very urgent problem, since most users won't be that crazy.
However, it would be nice if it doesn't break.

Screenshots

Desktop (please complete the following information):

• OS: macOS
• Browser: Chrome
• Version: latest

Focus bar doesn't scroll independently.

It appears that the scrolling of the focus view is the same as the weekview/page.

Condense actions.js

Some similar functions could be combined, such as the Edit Action functions, as to make the file shorter.

Deformed checkbox for overdue task in focus view

To Reproduce
Simply have an overdue task in focus view.

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots

Desktop (please complete the following information):

• OS: macOS
• Browser: Chrome
• Version: Latest

Deleting Selected Task Breaks Site

Using the task creator, start creating a task, select a tag, but don't finish creating the task.
Now go to settings and delete the tag you selected.
Close out of settings and the page crashes.

Text should clear after tag selection.

When selecting a class to add as a tag the text from the textbox is not cleared so you have to manually delete the text to continue adding more tags.

Focus View Scrolls Horizontally

In the fix for bug #57, the new focus view now scrolls horizontally when there's an overdue task.

Simple comment change

Change the comments to add more detail than their respective method names or just delete them.

This is a very strong box shadow.

CS 2110 vs ENGRD 2110

Describe the bug
A clear and concise description of what the bug is.

When importing CS 2110, the exams for ENGRD 2110 are also imported. (they're the same class, and it's an obvious bug)

To Reproduce
Steps to reproduce the behavior.

Screenshots
If applicable, add screenshots to help explain your problem.

Environment (optional)

• Browser [e.g. chrome, safari]
• OS: [e.g. macOS]

Additional context (optional)
Add any other context about the problem here.

CSS Not Minimized in Production Build

Didn't call as a foreign key

samwise/backend/app/api/models.py

Line 53 in b2b518e

tag_id = db.Column(db.BigInteger, nullable=False)

Would be easier to read if it is written as a foreign key

Editing a task name in future view doesn't update the task in focus

Have a task pinned in focus. Edit its name in future view. Click save. Focus does not update. Refreshing fixes it. This seems to be a regression.

No symbol to tell that the button is for removing a tag while registering

Circled part of image below:

Wrong view switcher offset

Describe the bug
For example, if you are in 5-day view and you continue to click on it. It will still change the offset.

To Reproduce
Switch to monthly view, go into future for some months, go back to 5-day view and continue clicking it.

During Onboarding, can add same class multiple times

Describe the bug
During Onboarding, can add same class multiple times

To Reproduce
Steps to reproduce the behavior:

1. Go to Onboarding
2. Add a class twice

Expected behavior
It probably shouldn't allow the same class added repeatedly.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Broken formatting when add class label along with the task

Unnecessary comments

argument names are self-explanatory

samwise/frontend/src/store/reducers.js

Line 96 in b2b518e

* @param {number} taskId the main task id.

Create subtask in subtask editor will immediately jump

Describe the bug
Create subtask in subtask editor will immediately jump

To Reproduce
Create a task in focus view.
Try to add a subtask.

Expected behavior
It should not make the subtask creation input focus jump.

Can create separate classes for new, delete, edit tasks

For file: samwise/backend/app/api/views.py

The bottom bar scrolls with the content, should probably be fixed.

The bottom bar isn't fixed so it scrolls with content (esp. when the focus bar gets very high) and when their is too little content is appears with a huge white gap between it and the bottom.

Tags in Add Task are out of order

In the add task section, class tags and other tags are mixed together, out of order.

Dedicated file for opening one JSON document

samwise/backend/app/courses.py

Line 3 in b2b518e

with open('app/sp19-courses-with-exams-min.json') as f:

This file is only three lines to open a single JSON doc.

Unexpected date picker shift in focus view

Describe the bug

To Reproduce
Have a task in focus view. It does not even need to be an overdue task.

Screenshots

Desktop (please complete the following information):

• OS: macOS
• Browser: Chrome
• Version: Latest

Unnecessary Comment

On UndoToast, there is a comment for the param "props, props all of the props" which seems pretty unncessary

?? text text comment

samwise/frontend/src/components/UI/SquareTextToggle.jsx

Line 18 in b2b518e

* @param {string} text text inside the button.

Mobile Focus View Button

In mobile view, the z-index on the focus view icon is messed up, so that if I scroll the page to where it overlaps with the progress bar, the progress bar blocks pointer events to the button.

Color Contrast

Some of the colors for tags do not work well with white texts.

Odd spacing in focus sidebar.

The spacing here is a little off, sometimes the buttons overflow off the card in the focus view.

Text overflow under the icons

Screenshots

Update Screenshot in README

The screenshot in README is outdated. We have a live version running now, so we should replace it.

Checkbox collapses for subtasks in focus view

Page Still Scrolls Vertically

Even with the new focus bar that scrolls independently, there's still a scroll on the entire page. That shouldn't happen.

Task Editor Losing Focus Regression

Describe the bug
When you are editing a task in the focus view, whenever you edited something and move to the another input box, focus will be lost. It's likely a regression bug originally raised in #88.

Expected behavior
Focus should not be lost.

Screenshots
If applicable, add screenshots to help explain your problem.

Margins/Padding is too narrow

The design spec has much larger margins.

Exam titles are non-descriptive.

All exam titles merely say "Exam". It would probably be better if they said "3110 Prelim" or "2800 Final" to provide descriptive tasks.

Datetime util function names should be more intuitive

Broken Object Spread Code in Edge

Object Literal Spread is experimental in Edge.
We need to use this babel plugin to compile that down.

Open Source License

We should consider adding an open source license.

No favicon

Focus checkboxes are broken.

Checkboxes are broken in the focus bar. Specifically, when unchecked they render 0x0 and when checked they "break" outside their bounds. I believe you might be wrapping them in a div that doesn't support them.

One letter name

f should be something else, not one letter!

samwise/backend/app/courses.py

Line 3 in b2b518e

with open('app/sp19-courses-with-exams-min.json') as f:

No Loading Screen

I just logged in to Samwise and I guess it took the server a long time to respond, but in the meantime, it let me in anyways, but with the default tags and no tasks, which freaked me out for a good second, as I thought everything had been deleted. It might be worth investing in a loading screen.

Unnecessary comment

samwise/frontend/src/components/UI/UndoToast.jsx

Line 42 in b2b518e

/**

Unncessary Comment

In FutureView.jsx there is an unnecessary comment about what the task variable is

API keys exposed in code

samwise/backend/app/auth.py

Line 12 in 2fe5b64

apiKey: "AIzaSyBrnR-ai3ZQrr3aYnezDZTZdw9e2TWTRtc",