Bed, Breakfast & Beyond

An AirBnB Clone
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

(back to top)

Getting Started

To get the proect up and running locally, follow the steps outlined below.

Prerequisites

Installation

1. Get a free Google Maps API Key at Google Maps Platform
2. Clone the repo

   git clone https://github.com/Kraftsman1/BBnB.git

3. Install packages and dependencies

   yarn install

5. Run project

   yarn dev

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Asigri Shamsu-Deen Al-Heyr - Twitter - Mail

Project Link: https://github.com/Kraftsman1/BBnB

(back to top)

Acknowledgments

(back to top)