Squeal

Table of Contents

1. About The Project
   • Project Wiki
   • Built With
2. Sample Features
3. Getting Started
4. Roadmap
5. The Team

About The Project

Squeal is a web application inspired by Yelp and created by a team of 4 software engineers.

(back to top)

Project Wiki

• Backend API Documentation
• Database Schema
• Features List
• Redux State Shape
• Frontend Routes
• User Stories

Built With

Frameworks, Platforms, & Libraries:

Database:

Database:

(back to top)

Sample Features

Search:

(back to top)

Getting Started

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

1. Clone the repo:

   SSH version:

   git clone git@github.com:amanduhkv/Squeal.git

   or

   HTTPS version:

   git clone https://github.com/amanduhkv/Squeal.git

2. Install packages

   pipenv install
   cd react-app
   npm install

3. Create a .env file and set the environment variables for SECRET_KEY and DATABASE_URL to your choosing.

4. Migrate and seed the files.

   flask run db init
   flask run migrate
   flask seed all

5. Run the server and start the react app

   pipenv run flask run
   cd react-app
   npm start

Roadmap

• Businesses
  • Create a business
  • Load all businesses
  • Load a business by detail
  • See list of current user's businesses
  • Update a current user's business
  • Delete a current user's business
• Search / Filter
  • Create a search filter
  • See the result of a search filter
  • Update a search filter
  • Remove a search filter
• Reviews
  • Create a review
  • Load all user's reviews
  • Load all of a business's reviews
  • Update a current user's review
  • Delete a current user's review
• Images
  • Create a business image
  • Create a review image
  • Delete a business image
  • Delete a review image

(back to top)

The Team

Amanda Vien:

Brandon Tasaki:

Jae Hwang:

Michael Jung:

Project Link: https://github.com/amanduhkv/Squeal

(back to top)