QuintinHull / CareBnB

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CareBnB


CareBnB is a clone of AirBnB but instead of serving guests who are traveling, CareBnB serves those in need of shelter. The project was inspired by the 2021 events in Northern Texas, where many Texans were left without power and water.

Try the site live: Here | Check out our documentation

How to run the site locally

  • Clone the repo
  • In the route directory, use the command pipenv install all dependencies
  • In the react-app directory, use the command npm install to install all dependencies
  • Make a copy of the .env.example file and edit to match local db configuration
  • Create a file in /CareBnB/react-app/src/components/GoogleMapsComponent called apikey.js with one export const named "googleApiKey"
  • Create a file in /CareBnB/react-app/src/aws called keys.js with one export const named "SECRET_ACCESS_KEY"
  • Create the database and user in psql
    • In a pipenv shell, run all migrations with flask db upgrade
    • Seed all data with flask db seed all
  • In the route directory, use the command flask run to run the backend server
  • In the react-app directory, use the comman npm start to run the front end

Technologies used in CareBnB

JavaScript

Python

SQLAlchemy

Flask

React

Redux

React Google Maps

Amazon Web Services

React Bootstrap

Heroku

Features that we implemented

  • Users can log in or sign up to access some functionality of the site.
  • A logged in user has the ability to host a spot that displays how many guests they can accept.
  • A logged in user can book a spot, and selecte how many guests they are booking for.
  • The search bar can locate using a search term and specify how many available spots.
  • A logged in user can utilize google maps to identify a spot close to them.

Challenges throughout the development process

We faced a few challenges while we were building CareBnB:

  1. Implementing google maps to allow users to search spots by their coordinates

  2. Implementing AWS to allow users to upload an image as a file instead of a image url

Developers

Developer

Mustafa Mousa Lane Johns Quintin Hull Jung Park
@mustafaomousa @lanejohns @QuintinHull @Jummies

About


Languages

Language:Python 78.9%Language:CSS 17.6%Language:HTML 1.3%Language:Dockerfile 1.1%Language:Mako 0.9%Language:Shell 0.1%