Skip to content

Latest commit

 

History

History
115 lines (70 loc) · 3.4 KB

README.md

File metadata and controls

115 lines (70 loc) · 3.4 KB
Raw

Caffa

Welcome to Caffa!

Caffa is a community-driven platform for coffee lovers all around the world. Search your favourite Coffee through our image search to learn more details about the coffee itself, what others are saying about it and where you can find it at your local shops.

This project was developed by Connie Ho, Justin Ly, and Kevin Phan

Visit our website at: http://caffa.herokuapp.com/

Final Product

Home Page

"GIF of Home Page"

Image Search

"GIF of image search"

Coffee Page Interactions

"Screenshot of Coffee Page Interactions"

Home Page Desktop

"Screenshot of Home Page"

Browse Coffees

"Screenshot of Browse Coffees"

Coffee Details

"Screenshot of Coffee Details"

Initial Setup

To run the following project on your machine please follow the steps below:

Backend setup:

  1. Create an .env in the main backend directory where you'll be providing the required API Keys.

  2. Obtain an API key from Google Vision (for image scanning recognition) and Yelp Fusion ( for recommended local cafes). Place these in the .env file you created in the backend. You will need to use the same Google Vision API Key for the Frontend setup as well so keep this handy for now.

Frontend setup:

  1. Create an .env in the main frontend directory where you'll be providing the required API Keys.

  2. Take the Google Vision API key you obtained earlier for the backend setup and put this in the .env file.

  3. Visit Firebase and obtain an API key and put this in the .env file as well.

Getting Started

  1. Install all frontend dependencies while in the main frontend directory.
npm install
  1. Install all backend dependencies while in the main backend directory.
npm install
  1. Reset the database.
npm run db:reset
  1. Run the server for the frontend and backend.
npm start
  1. Lastly, visit the website on your localhost.
http://localhost:3002/

Dependencies

  • axios: ^0.21.1,
  • bcrypt: ^5.0.1,
  • body-parser: ^1.18.3,
  • cookie-parser: ~1.4.4,
  • cookie-session: ^1.4.0,
  • debug: ~2.6.9,
  • express: ~4.16.1,
  • morgan: ~1.9.1,
  • pg: ^8.5.1,
  • pg-native: ^3.0.0,
  • yelp-fusion: ^3.0.0

Future Features

  • User interactions such as following other users.
  • Integrated marketplace to buy and sell coffee on Caffa.
  • Admin dashboard to manage new coffee entries by customers to retain consistency with existing records in the database.

Known Issues/Bugs

  • Filtering not on page 1 can cause errors
  • Distance is inaccurate on yelp maps
  • Google Vision API sometimes displays errors