Giter VIP home page Giter VIP logo

cmucourses's Introduction

CMU Courses

CMU Courses (AKA ScottyLabs Course Tool) is a web application designed to aid students at Carnegie Mellon University in browsing courses, including information about course evaluations and schedules. It is actively maintained by ScottyLabs.

This is the second iteration of the Course Tool. The second version is a rewrite of the frontend and backend, with the inclusion of new features (currently a work-in-progress) such as:

  • Search
  • Filters
  • Professor Search
  • Schedule Creation

This new version is currently deployed at cmucourses.com. This project is currently undergoing development, so expect large changes to the codebase and features to be unstable.

Getting Started

To get started, run npm install && npm run db-generate in the root folder, and obtain a copy of the .env file. (You can use .env.template as a reference.)

Frontend

To run the frontend in development mode:

cd frontend
npm run dev

This runs the frontend at http://localhost:3010. It also watches for changes and reloads when a file is saved.

To build and deploy the frontend, instead run:

npm run build
npm run start

Backend

To run the backend in development mode:

cd backend
npm run dev

The backend should now be serving requests at http://localhost:3000.

To deploy the backend, run

npm run start

Scrapers

More information about the scrapers used to collect the data may be found at this repo.

Technologies

The Course Tool is built with several technologies.

  • The frontend is built using NextJS and React, Redux, Typescript and TailwindCSS.
  • The backend uses Express, MongoDB and JS.
  • The scrapers are written in JS.

cmucourses's People

Contributors

btwj avatar adrastopoulos avatar xavilien avatar lhwhatever avatar hdavidethan avatar anudaweerasinghe avatar mgmgperson avatar dependabot[bot] avatar porkboi avatar ghostof0days avatar knaoinr avatar luca-borletti avatar icyviolet23 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

James Cloos avatar  avatar  avatar Deploy Account avatar  avatar  avatar  avatar

cmucourses's Issues

[Bootcamp] Match Courses in the Schedule Selector without Dashes

Task Brief

Modify the filtering for courses in the Schedule Explorer to match course codes without dashes.
The file that should be changed is components/ScheduleSearch.tsx.

Expected Deliverables

Searching for courses on this page shouldn't require dashes, e.g. 15150 and 15-150 should pull up the same courses.

Estimated Completion Time

1 hour

Reviewers

@btwj

[Bootcamp] Add tooltips for semesters

Task Brief

A new student might be unable to tell that F 2022 means Fall 2022 and M2 2022 means Summer-2 2022.

Expected Deliverables

Add a tooltip to explain this.

Estimated Completion Time

1 hour

Reviewers

@Lhwhatever

[Feature] Add lint rules for backend

Description

The backend code is not lint-checked or format-checked by either eslint or prettier. Add the eslint recommended rules at the minimum and additional rules for this specific project (if necessary).

Designs

No response

[Feature] Add a search box in the department dropbox component

Description

It would be nice if we could find departments in the department filter list in a quicker way by searching by name (“Computer”), abbreviation (“CS”) or department number (“15”).

Designs

Here’s a quick mockup of what it could look like:

[Feature] Schedules Explorer Timetable

Description

This is a pretty big feature, but it involves major changes to the schedule explorer.

  • Based on the courses in the schedule, we should render a weekly timetable similar to SIO's one.
  • For this feature, we need to build an interface to select sections for courses.
  • This feature also requires a rather complex weekly timetable component.

Designs

No response

[Bootcamp] Add a link to the GitHub Repo

Task Brief

In the right controls with the login and dark mode buttons, add a button linking to this repo.

Expected Deliverables

New button.

Estimated Completion Time

1 hour

Reviewers

@btwj

[Feature] Rebrand + Footer

Description

This website is currently referred to as both the (ScottyLabs) Course Tool or CMU Courses.
We should stick to CMU Courses, since that's our URL.

  • Change branding (header, titles) to CMU Courses
  • Make a new logo and favicon for CMU Courses
  • Add a footer containing information about ScottyLabs and CMU Courses:
    • Maintained by ScottyLabs (with link to ScottyLabs website)
    • Core Team, GitHub repo
    • Interested in joining us? ...
    • Once the beta is over, we can move the feedback link here.

Designs

No response

Professor Search skeleton page

Build out a skeleton page for professor search.

  • Should be linked to from the FCE Browser, potentially from the Lecture/Section details too
  • Should display that professor's past FCEs (potential issues include professors with name changes, but we'll ignore that for now)

[Bug] Cannot backspace on "Semesters to Show" field in Aggregate FCEs when the input is a single digit

Expected Behavior

A user should be able to clear the entire field (e.g., from the default value of 2) and key in a new number.

Instead, emptying the field keeps the current value. This makes it difficult to change a single-digit input (e.g. from 2 to 3).

Steps to Reproduce

  1. Go to https://cmucourses.com/
  2. Change the "Semesters to Show" field/

Device Information

Desktop/Mobile: Desktop and Mobile
OS: Found on Linux (EndeavourOS) 5.19.0 / Windows 11 / Android 12
Browser Version: Firefox / Chrome

Could bookmarking be renamed?

image

When I first used it, it took me a while to realize that I needed to bookmark courses in order to see the total number of FCEs for my classes. What if we called it a "schedule" instead and replaced the bookmark button with a "plus" icon to "add to my schedule"? Then, we could replace the "Bookmarked" tab on the navbar with a "My Schedule" tab. This might make it more intuitive to new users

[Bug] Safari bugs

Expected Behavior

  • Search bar doesn't pin to the top in Safari
  • Icon in top left doesn't render

Steps to Reproduce

Use Safari

Device Information

Desktop/Mobile: Desktop
OS: macOS Catalina 10.15.7
Browser Version: Safari 13.1.3

[Feature] Allow re-ordering of schedules

Description

Currently, schedules can't be re-ordered once created. This makes it harder to locate certain schedules especially if they were created out-of-order.

It would be good to have some way of dragging and dropping schedules (or even up/down arrow buttons) to re-order them.

Designs

No response

[Bug] Prevent search bar from going off page

Expected Behavior

If too many courses are selected, the search bar goes off the page on Desktop.

Steps to Reproduce

Add many courses.

Device Information

Desktop/Mobile: Desktop
OS: macOS Monterey 12.3.1
Browser Version: Safari 15.4

[Bootcamp] Activate Department Filter

Task Brief

It's not intuitive that you have to click the department in the dropdown and then the checkbox.

Expected Deliverables

Make it so that adding departments in the dropdown activates the department filter.

Estimated Completion Time

2 hours

Reviewers

@btwj

[Bootcamp] Display "No FCEs Available" in FCE Browser

Task Brief

If there are no FCEs available, the FCE Browser card in the Course Detail page should state something like "No FCEs for requested semesters available".

image

Expected Deliverables

Make the FCE Browser card display a message if there are no FCEs available.

Estimated Completion Time

1 hour

Reviewers

@btwj

[Bug] Schedules Explorer page not very responsive

Expected Behavior

  • Table should overflow instead of having the columns cramped
  • Dropdown is buggy due to long rows wrapping into multiple lines

Steps to Reproduce

Open Schedule Explorer on mobile

Device Information

Desktop/Mobile: Mobile
OS: iOS 15.5
Browser Version: Safari 15.5

[Feature] Add filtering by number of units

Description

Allow filtering for courses on the main page by a range of units. This is useful for finding smaller courses that fit one's schedule.

Designs

No response

[Feature] Prerequisite (and Postrequisite) Tree

Description

In the course detail page, render a prerequisite tree. For example, for a course E with prerequisites (A or B) and (C or D), we should show something like

A --|
   one of --|
B --|       |
          all of --- E
C --|       |
   one of --|
D --| 

Clicking one of the prerequisite courses should in turn render that course's prerequisite tree.

Designs

No response

[Feature] Warn about the travel time between buildings while making schedules

Description

With the time between back to back lectures reduces to only 10 minutes, I find it hectic having to keep checking which building the classes are and where the building is on the map to make sure I have enough time to move to classrooms. It would be great to have automatic warnings for this.

Happy to work on this if there is demand and someone can guide me.

Designs

No response

[Bootcamp] Change title of pages

Task Brief

Right now, the title of the page is static (it always says ScottyLabs course tool). Make it dynamic: on /index.html, it should say "Course Search". On each of the course pages, make it the course code + name of the course.

Expected Deliverables

Change the titles of each page.

Estimated Completion Time

1 hour

Reviewers

@btwj

[Bug] Semesters Available not showing in Course Page

Expected Behavior

image

Missing from the main course search page.

Steps to Reproduce

Look at the course search page.

Device Information

Desktop/Mobile: Desktop
OS: macOS Monterey 12.3.1
Browser Version: Safari 15.4

Responsive layout for mobile

I don't think the layout has been configured yet for mobile screens. It's currently still quite difficult to use on phones

image

[Bootcamp] Make Schedule Links link to instructor pages

Task Brief

Right now, there are no links for instructors in the schedule card. Create a link to the correct instructor page if the name is not "TBA".

Expected Deliverables

A link should be present similar to the FCE Browser.

Estimated Completion Time

1 hour

Reviewers

@btwj

Add location tooltips

When hovering over locations in the schedule explorer, display the full names of venues as a tooltip.
Venue names can be found here.

  • You can use Radix UI's Tooltip primitive or react-tooltip to create tooltips.

[Feature] Migrate backend code to TypeScript

Description

Right now the majority of back-end code is written in JavaScript.

For the ease of leveraging static analysis, we should rewrite the back-end code in TypeScript.

Would need to modify the deployment process accordingly.

Designs

No response

[Feature] Display campus availability of each course

Description

The current interface makes it difficult to identify courses that are only available on the Qatar campus. For instance, 15-316 is taught only in Pittsburgh during the Fall semester, and only in Doha during the Spring semester.

image

I think it would be nice to make that clearer in the interface.

Designs

No response

Page not persisted

When going back to the main search page, current page number isn't persisted.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.