Skip to content

the-valar/STUDy

Repository files navigation

STUD(y)

STUD(y) is an application that allows users to find optimal study locations in close proximity to them.

By leveraging crowdsourced user ratings for local cafes, STUD(y) users can indicate their preferences, and STUD(y) will return results that are tailored to that specific user.

Team

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Tasks
  4. Team
  5. Contributing

Usage

Search a location in the bar to find study spots near the location Because our database has minimal data, please search "Hack Reactor NYC" and click 2Beans for existing reviews

Requirements

  • Node.js
  • Yelp API Key
  • MySQL ^5.7.x

Development

Installing Dependencies

From within the root directory:

npm install

Contributing

See CONTRIBUTING.md for contribution guidelines.