Skip to content

Latest commit

 

History

History
125 lines (83 loc) · 4.01 KB

README.md

File metadata and controls

125 lines (83 loc) · 4.01 KB
Raw

Graduation Project: Dirty Paws 🐾

Dirty Paws is a cartoon pet-themed dating app built with Node, React, Express, and PostgreSQL.

Contributors:

  • 👩🏻‍🎨 Ann Bui: the master of frontend, an amateur UX/UI designer and dogs lover
  • 👨🏼‍💻 Dan Lindeblom: the master of backend, data and a sports fanatic
  • 👨‍🏭 Declan Davis: the master of functionality, cats and origami

Main Features:

  • Users can create/update profiles
  • Users can view other profiles and send 'a love paws' to form matches.
  • Only after two users have both liked each others, they can view messages and chat with their matches in real-time.
  • Users can earn treats to upgrade their badges to show off.

Features we wish to accomplish:

  • Users can register using their Google account/ Google authentication
  • Users can enable Location Services and set a maximum search radius for other profiles
  • Users can connect to Spotify and share music with their matches
  • Users can video chat with their matches
  • Users can unmatch
  • Matching uses a weighted algorithm to favour users with more treats/badges

Credits

We would like to express our appreciation and gratitude for the knowledge and unending support of our instructors, mentors, and staff at Lighthouse Labs. As well, we want to acknowledge and shout out to all the online resources we consulted during the development of this project.
It is truly by standing on the shoulders of giants that we have made it to where we are today!

Final Product

👋 Watch Demo Presentation Here 👋

Landing Page

Landing-page.mp4

Update Your Profile

Update.your.profile.mp4

Paws: searching for your perfect match

Find-your-perfect-match.mp4

Messages: live chat with your matches

Message-in-real-time.mp4

About Page

About-page.mp4

Entity Relationship Diagram (ERD)

"ERD"

Dependencies

Front End

  • axios: ^0.27.2
  • bootstrap: ^5.2.0
  • classnames: ^2.3.1
  • react: ^18.2.0
  • react-bootstrap: ^2.5.0
  • react-dom: ^18.2.0
  • react-lottie: ^1.2.3
  • react-router-dom: ^6.3.0
  • react-scripts: 5.0.
  • react-spring: ^9.5.2
  • styled-components: ^5.3.5

Back End

  • cookie-parser: ~1.4.4
  • debug: ~2.6.9
  • dotenv: ^16.0.1
  • express: ~4.16.1
  • morgan: ~1.9.1
  • pg: ^8.7.3

Dev-Dependencies

  • nodemon: ^2.0.19

Getting Started

  1. Clone this repos.

  2. Create the .env by using .env.example as a reference: cp .env.example .env

  3. Create database using psql

  4. Update the .env file with your correct local information

    • username: labber
    • password: labber
    • database: final

The root project directory contains two directories: Front-end and Back-end
From here, we recommend you have two separate terminal window opens

On your Backend terminal

  1. Navigate to the back-end folder. Install dependencies npm i

  2. Reset database: npm run db:reset

    • Check the db folder to see what gets created and seeded in the SDB

  3. Run the server (back-end): npm start

    • Note: nodemon is used, so you should not have to restart your server

On your Frontend terminal

  1. Navigate to the front-end folder. Install dependencies npm i --force

  2. Run the client (front-end): npm start

  3. React will kick in and auto serve the app in your browser at http://localhost:3000

  4. Start to build your profile, treats, and paws. LET'S GET DIRTY!!!


Hope you enjoy the app and have a nice day :D