Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 3.16 KB

README.md

File metadata and controls

84 lines (65 loc) · 3.16 KB

Culinary Critique

Culinary Critique is a web application that allows UCLA students to review and rate campus dining halls.

Table of Contents

Features

  • User Authentication: Secure login and registration for personalized experiences.
  • Search Functionality: Real-time search for dining halls and user profiles.
  • Ratings and Reviews: Leave detailed reviews and ratings for dining halls.
  • User Profile: View your profile and past comments.
  • Account Management: Update your profile photo in your Account Settings
  • Dynamic Leaderboard: Displays the top-rated dining locations based on user reviews.

Technologies

  • JavaScript JavaScript
  • Node.js Node.js
  • React.js React.js
  • Express.js Express.js
  • MongoDB MongoDB
  • AWS S3 AWS S3

Setup

To run a local instance of Culinary Critique, first clone or download a copy of this repository and navigate to the new folder. Once you're in there, follow the instructions below to initialize a local instance of each part of the application.

Backend Instructions

Setup

To set up the dependencies for the backend server, run:

cd api
npm install

which should download a set of node_modules for the backend server.

Create a .env file in the api folder with the following contents:

PORT={insert port number}
ATLAS_URI={insert mongoDB link}
S3_ACCESS_KEY={insert S3 access key}
S3_SECRET_ACCESS_KEY={insert secret S3 secret key}

Running

In the api terminal run

npm start

Frontend Instructions

Setup

To setup the dependencies for the frontend application, first create a new instance of terminal, then run:

cd client
npm install

which should download a set of node_modules for the backend server.

Create a .env file in the client folder with the following contents:

REACT_APP_PORT={insert port number}

Running

To start the frontend application, in the client terminal, run:

npm start

Citations

aws-sdk tutorial for react: https://medium.com/how-to-react/how-to-upload-files-on-an-s3-bucket-in-react-js-97a3ccd519d1

Aws-sdk migration from v2 to v3: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/migrating.html

Authors

Culinary Critique was made as a project for CS 35L taught by Professor Paul Eggert at UCLA in Spring 2024. Made by: Duncan Hackmann, Marco Lombardi, Nathan Leobandung, Bryan Mui, and Rabbun Ishmam Haider