/skybnb

This project clones the popular website, Airbnb with a star wars theme to it. Our web application will provide users the ability to create accounts, log in as a demo, book spots, search for spots, and leaving a rating and review on spots.

Primary LanguagePython

Welcome to the skybnb github repo!


Logo

Skybnb

This project clones the popular website, Airbnb with a star wars theme to it. Our web application will provide users the ability to create accounts, log in as a demo, book spots, search for spots, and leaving a rating and review on spots.
Explore the docs »

View Site · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Click here to view Skybnb live on the web!

homepage ss

Overall Structure

Back End

The app was built using Flask and SQLAlchemy on the back end with a PostgreSQL database. The backend structure is RESTful with AJAX requests that are fullfilled with JSON Objects. Model associations are used to minimize database queries to the backend, assuring speed and reliability.

Front End

The front end is built with React and Javascript while utilizing Redux architecture, producing a lightning-fast user interface and calling upon dynamically rendered components.

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Here is everything we need you to do to get started with Skybnb.

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/V3RS/skybnb

  2. Install NPM packages

    npm install

  3. Add a '.env' with your environment variables to the root of your local directory

  4. Create a postgreSQL user

    CREATE USERS <<your username>> WITH PASSWORD <<your password>> CREATEDB;

  5. Create your database

    CREATE DATABASE <<db name>> WITH OWNER <<your username>>;

  6. Upgrade and seed your database

    flask db upgrade
flask seed all

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact & Acknowledgements

Project Link: https://github.com/V3RS/skybnb/