patrickmck34/api-project

Go-There

A clone of the popular AirBnB web application. Go-there is a marketplace designed to allow owners of rental properties to make their spots available to the public as well as allowing the public to view and reserve time at their desired location.
Explore the docs »

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

A clone of the popular AirBnB web application. Go-there is a marketplace designed to allow owners of rental properties to make their spots available to the public as well as allowing the public to view and reserve time at their desired location.

(back to top)

Built With

• React
• JavaScript
• HTML
• CSS
• SQL
• Express

(back to top)

Getting Started

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

Prerequisites

• npm - npm install

Installation

1. Clone the repo

   git clone https://github.com/PatrickMcK34/API-project.git

2. Install NPM packages

   npm install

3. Navigate into the backend folder and from there use the command npm start to start the backend server.

4. Create an additional terminal window and navigate to the frontend folder. From here use npm start again to launch the frontend of the application.

(back to top)

Usage

Create your account with secure hashed password protection.

The home page displays each spot with thumbnails with only minimum infomation. Click to see more.

Once in the details page the user may create a review, manage their own spot or by using the Go-There button in the Nav bar, create a new spot.

With validation in place and suggestions prepopulating the forms, creating a new Spot is simple.

(back to top)

Roadmap

• Spots
• Reviews

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)

(back to top)

Contact

Patrick McKinney [email protected]

Project Link: https://github.com/PatrickMcK34/API-project

(back to top)

(back to top)