ethanl21 / retroratings

RetroRatings: CSUF CPSC-349 Project 1

RetroRatings

RetroRatings is a website used to rate nostalgic things from the 90s and 2000s.

Features

• Rating nostalgic items from 0-5 stars
• Upload new items for anyone to rate
• See all your ratings in a tierlist format
• Sign up and log in with Email, GitHub, or Google

Usage

RetroRatings is deployed via Firebase Hosting. It can be accessed at retroratings.web.app.

To deploy your own instance of RetroRatings, clone this repository and replace the Firebase config data located in src/config/firebase.ts. Running RetroRatings requires Firebase Authentication, Firestore Database, Firebase Cloud Storage, and App Check to be correctly configured:

• Firebase Authentication
  • The Email/Password, Google, and GitHub providers should be enabled.
• Firestore Database
  • Two collections, rating-items and user-ratings should be configured.
• Firebase Cloud Storage
  • A folder named rating-items-images should be configured.
• Firebase Hosting
  • A GitHub actions deploy workflow is included to allow GitHub actions to deploy directly to Firebase Hosting. A repository secret named FIREBASE_SERVICE_ACCOUNT_RETRORATINGS must be set in order to use this.
• App Check
  • Configure App Check.
  • To test locally, configure debug mode and add a .env.development.local file to the root of this repository with the following contents:

  VITE_APP_CHECK_DEBUG_KEY="app check debug key here"
  

For additional documentation on the back-end API, see API.md.

To run RetroRatings' frontend locally:

git clone https://github.com/ethanl21/RetroRatings.git
cd retroratings
npm i
npm run dev

Attribution

RetroRatings is developed and maintained by the following individuals:

• Allan Cortes @Nalluh
• Raquel Cruz @rlcruz324
• Jose Gonzalez @jose-gonzalez1
• Ethan Lew @ethanl21

Additionally, the following open-source libraries and tools are used:

• Vite

• Typescript

• eslint

• react-bootstrap

• react-hook-form

• dompurify

• react-firebase-hooks

• react-icons

• react-simple-star-rating

• nanoid

RetroRatings is distributed under the MIT license.

retroratings's Issues

User Authentication

Users should be required to log in to our website before they can use any of its features. This is requirement 1 of #1.

This actually seems fairly easy to implement using Firebase Authentication. We can add authentication with basic email/password, Google, and GitHub without paying anything so I think these would be a good option for our authentication methods.

Determine requirements

We should determine what features our website should have before we work on it so we know what to do.

The project rubric lists these requirements:

• 1. The site has authorization/authentication code requiring users first to register, then to sign in
• 2. The site blocks most of the website from the user unless they log in
• 3. The site uses HTML, CSS, and JavaScript to create forms for its front end
• 4. The site uses a JavaScript library to communicate with the back-end over the network
• 5. The site uses Promises and Deferreds to check if the communication was successful, and displays an error if the server is down
• 6. The site uses a NoSQL or a SQL database to store its data
• 7. Website is attractive
• 8. Website’s purpose can be ascertained in less than 10 seconds