Skip to content
Amanda Anderson edited this page Oct 22, 2022 · 3 revisions

Welcome to the RateMyCoop wiki!

Purpose

RateMyCoop is a website for UVic students to rate their co-ops in order to help others make decisions on where they want to apply to work.

Framework

RateMyCoop uses the MEVN stack. MEVN stands for MongoDB, Express.js, VueJS, Node.js. Currently, RateMyCoop uses Bootstrap (not BootstrapVue) for the component design.

Plan

We decided to focus on a desktop version, and make the components as resizable as possible for a future mobile webpage.

The RateMyCoop site opens on the home page, where there is a short blurb explaining the website and easy access to searching for a review.

All pages will have a header/footer with the header containing a link back to the homepage, search review page, create review page, and account (if implemented). The footer will contain links to an about us page, RateMyCoop GitHub, and VikeLabs website.

The create review will have fields for company, job title, university program, academic year, length of co-op, a 5-star rating for enjoyment, personal growth, and support. Their will also be a text box for further comments or descriptions the reviewer wishes to include. We decided not to include a field for the wage the reviewer may not be comfortable revealing that, and as wages frequently change and the current year's are easily accessible from the internal co-op board. The create review page will also have a create button once all the fields are complete.

The search review page will have a search bar for keywords, and some type of filter for searching specific fields. Still need to decide what type of information will be displayed about a review right on this page and how many reviews should be displayed on one page before paging the results. Ideally, each review result will be able to be made full-screen to see all the details of the review.

The FAQ page is to answer expected questions about how to use the website.

There may be an about us page and a user profile page. There may also be pages for editing a review and reviewing overall company information (and associated reviews).

These pages were initially planned using a Work Breakdown Structure, but this structure has not been updated since code started to be written. The format of a work breakdown structure is as follows:

  • The first level (1) corresponds to the entire RateMyCoop project.
  • The second level (1.?) corresponds to desired pages for the application.
  • The third level (1.?.?) corresponds to desired components, functionality, or links to other pages on their parent page.
  • The fourth level (and any further levels) correspond to further specification or breakdowns of their parent component.

Tasks

The overall picture of next steps/future tasks are as follows:

  • UI
    • Develop a search review page
    • Develop a full screen review page
    • Finish interactive 5-star rating on create review page
    • "Coop" should be replaced with "Co-op" where ever possible
    • Design a logo
    • Develop an about us page
  • Database Integration
    • Save review to database from create review page
    • Access and search reviews on search review page
    • View/access all data saved about review on full-screen review page (exclude data about user who created it)
  • Database
    • Create a consistent format and location to save a review
    • Consider what other information, if any, should be saved in the database

Questions

  • Accounts?
    • Should we require users to have an account to create a review?
    • Should reviews be editable (if user is logged in)?
    • What information should be saved about a user with an account?
    • What information about an account is displayed to others on website?
    • Should we verify that the user is a student? If so, how (eg. with a student email)?
  • Should we be saving company information, so that all reviews for a particular company can be viewed/compared on one page?
  • What system is in place to manage the content of the reviews? (ie. are they appropriate? useful?)

Inspiration

  • Glassdoor - used for rating jobs at companies
  • RateMyProfessor - used for rating professors and provide recommendations for surviving their classes
Clone this wiki locally