SLOStudySpots

Monorepo containing all SLOStudySpots related code.

About

SLOStudySpots is a web application designed to help students and residents of San Luis Obispo find the best study spots in the area. This platform provides users with detailed reviews, ratings, and photos of various locations, including cafes, libraries, and public spaces, making it easier to find the perfect place for study or work.

Built With

• 
• 
• 
• 
• 

Getting Started

To get a local copy up and running, follow these steps.

Installation

1. Clone the repo

   git clone https://github.com/thienan11/SLOStudySpots.git

2. From the monorepo root, install NPM packages (dependencies)

   npm install

Then, refer to and follow the individual package READMEs for specific package information.

Project Configuration

This project requires environment variables to be set up in a .env file for proper configuration and operation.

In the server package, create a file called .env or .env.local and refer to the .env.example file located in the server package.

Packages

• Prototype: uses only static HTML, CSS, and Javascript.
• Server: backend Express API, with communication to MongoDB and authentication.
• App: frontend single-page app using Lit.