Skip to content

pareesakd1118/housemate-hunter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Housemate Hunter 🏠

Live in San Fransicso or Denver and looking for a roommate? You're in luck! Use Housemate Hunter to search for roommates in your city and filter roommates based on preferences. Want to find a roommate with or without a pet, with a similar budget, and of a certain gender/age? You have come to the right place! Our application allows you to filter potential roommates by any of the aforementioned parameters and more, as well as see pictures and read bios/important non-negotiables for each specific person to find the perfect match. Happy housemate hunting!

Contributors

Technologies Used

React badge router javascript badge html badge css badge cypress badge vscode badge lighthouse badge

Preview:

Recorded_screen_1_V1.mp4

Installation Instructions:

  • Visit Housemate Hunter here, OR
  1. clone the frontend repo to your machine

    git clone https://github.com/pareesakd1118/housemate-hunter
    
  2. Run cd housemate-hunter

  3. Run npm install to install packages

  4. Run npm start to run the local server

  5. clone the backend repo to your machine

    git clone [email protected]:Virulencies/housemate-hunter-api.git
    
  6. Run cd housemate-hunter-api

  7. Run npm install to install packages

  8. Run node server.js to run the local backend server

  9. Return to frontend to use through the app!

Run End to End testing using Cypress

  1. Run npm i -D cypress
  2. Run npx cypress run in root directory to run cypress

Context:

  • This project begun in the 2nd week of the contributors learning React
  • Approximately 15 hours to complete test suite and functionality
  • Goals:
    - Research and implement a "stretch" technology into the application.
    - Continued work with implementing router with a React application.
    - Continued work with E2E testing with Cypress. 
    
  • Wins:
    - Used Express, Knex, and PostgreSQL to build a server/database for the first time!
    - Implemented loading indicators when changing URL's and fetching data.
    - Implementing an apply filter function to filter roommates based on a number of preferences, including if the user smokes, has a pet, and budget. 
    
  • Challenges:
    - Deployment of the database and server. 
    

Future Improvements:

- Add a favorites feature to be able to track roommate(s) the user is interested in living with.
- Add the ability to message a roommate.
- Add more cities to explore roommates in!