Skip to content

kevinlongboy/AirBnB

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CraneBnB Logo


🔎 Contents


🌊 Welcome to Seattle

... And welcome to CraneBnB, a virtual meeting place that connects visitors, and the like, to the finest guest maisonettes in the Greater Seattle Area. Inspired by AirBnB, CraneBnB allows its members the ability to host visitors in their own homes, or become guests in other members' spaces.

Don't miss this truly once in a lifetime opportunity to experience what Seattle has to offer. Where else can you see an ocean wave, a fish fly, a mountain peak, and the world's largest needle?

Frasier and Niles Toasting GIF


👀 API Overview

When navigating the site, users have the option to choose between the role of a Host, a Guest, or perhaps even both!

Spots

The main feature of CraneBnB

As a Host, users are able to list their home on the site and highlight its best qualities in the listing. Hosts should give a brief description of their home, henceforth known as a "Spot", then choose a befitting rate for a nightly stay.

As a Guest, users are able to peruse through CraneBnB to find the perfect place for their stay in Seattle.

Frasier Alistair Hilarious Chair GIF

Reviews

Hear the people's voice

CraneBnB gives its members the ability to voice their opinions and share their experiences from previous stays.

Users can also delete any reviews they've previously posted, if they so choose.

Roz Why are You Telling Her This GIF


🖱 Get Started

Ready to install CraneBnB? Follow the instructions below:

1. Navigate to GitHub:

  • Click here to be redirected to the CraneBnB page

Navigate to GitHub GIF

2. Download the API:

  • Click the "Code" button
  • Select "Download ZIP" from the dropdown menu
  • Save the file in your desired location

Download the API GIF

3. Open the repository:

  • Navigate to the location where you previously saved your zipped file
  • Unzip the file by double-clicking on the icon, or by right-clicking on the icon and selecting "Open"
  • This unzipped folder is the repository which contains both the backend and frontend components of the API

Open the repository GIF

4. Initialize the backend:

  • Open a new terminal
  • Navigate to the backend folder
  • Download dependencies by running the command: "npm install"
  • Initialize your database by running "npx dotenv sequelize db:migrate"
  • Populate your database by running "npx dotenv sequelize db:seed:all"
  • Start the backend server by running the command: "npm start"

Initialize the backend GIF

5. Initialize the frontend:

  • Open a new terminal
  • Navigate to the frontend folder
  • Download dependencies by running the command: "npm install"

Initialize the frontend GIF

6. Launch the app:

  • From the frontend folder, run the command: "npm start"
  • Allow React to open the app in your browser
  • Welcome to CraneBnB

Launch the app GIF


⏳ Future Implementations

Bookings

Bookings will supplement the Spots feature with functionality. Guests will be able to make, modify, and delete a reservation for a Spot, while Hosts will be able to view and manage any reservations for their own listings.

Martin Satisfied GIF

Images

Images feature will bring life to both Spots and Reviews. Hosts will have the ability to add, modify, and delete images for their Spot listings, and Guests will be able to do the same for any reviews they've written.

Daphne Victorious GIF


📚 Languages and Libraries Used

Framework:

JavaScript Node.JS HTML CSS

Frontend:

React Redux

Backend:

SQLite Sequelize Express PostgreSQL


🧑‍💻 Visit the Site

Check out CraneBnB for yourself. Click the icon below to be redirected to Heroku, the current hosting site for the fullstack API:

CraneBnB live site hosted via Heroku


💙 I'm Listening...

Developer's GitHub Page Developer's LinkedIn Page

Frasier I'm Listening GIF