daAirBuh-N-Buh

AirBnB Clone Project
Checkout the Docs »

View Demo Site · Report Bug ·

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contact

About The Project

This is a fullstack clone project bringing together the backend and frontend to approximate a recreation of AirBnB and some of their site's main features

(back to top)

Built With

• 
• ExpressJS: https://expressjs.com/
• Sequelize: https://sequelize.org/
• Redux: https://redux.js.org/

(back to top)

Getting Started

Below is how you can get the project started in a local environment

Prerequisites

You will need to define a .env file for backend to setup a database port as well as filepath, and generate a JWT Token / SECRET_KEY

• Ex: .env

  PORT=8000
  DATABASE=db/dev.db

Installation

1. Clone the repo

   git clone https://github.com/jacoblauxman/AirBnB-Proj.git

2. Install NPM packages

   npm install

3. Run via NPM start in backend and frontend folders

   npm start

(back to top)

Usage

Goal of this project is to accurately imitate/clone the aspects of AirBnB's website, specifically their handling of user and spot data as well as reviews -- full CRUD operations!

(back to top)

Roadmap

• User - Login/Logout, Signup, Restore Session and permissions within site
• Spots - Show all in display, see details of specific spot, add a spot as well as images of spot (owner Auth)
• Reviews - Show all reviews of a spot, user, and edit/update/delete features as well as review Image association

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Jacob Lauxman - jlauxman@gmail.com

Project Link: https://github.com/jacoblauxman/AirBnB-Proj

(back to top)

Acknowledgments

Thankful for all the instructional and peer support in all areas of this project

(back to top)