ShareBnB

Tired of indoor game nights, Netflux watch parties, but not that interested in camping / glamping / 5-hour hiking through the woods with your friends? Planning a birthday bash, a family reunion, a yoga retreat, and your 500sq.ft apartment isn't making the cut? Look no further than Sharebnb, where we connect backyard oases(ises?)🏕️ and sparkly cerulean pools🏝️ with eager guests looking to plan their next mildly-outdoor getaway!
View Demo ▶️ · Report Bug 🐛 · Request Feature 🙏

Table of Contents

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

About The Project

Sharebnb is a space sharing app where users can browse, like, and rent out outdoor spaces.

This is the frontend application, bootstrapped with Create React App. It uses Bootstrap for styling, and is deployed through Render.

It includes a RESTful API to interface with Python-based Sharebnb Flask Backend, and integrates AWS S3 for file storage with a PostgreSQL database, hosted on ElephantSQL.

Both frontend and backend were originally built as a project during a 4-day sprint in the Rithm School curriculum.

Project Architecture & Tooling

Topics explored in this project:

• Building RESTful APIs and consuming them via AJAX
• Separation of concerns between frontend and backend
• React component design and state management
• Separation of components based on logic and display functionalities
• React Router
• Relational database design and modeling
• Integrating AWS S3 services for secure file handling to reduce database load

This project a WIP -- Please refer to the roadmap for the list of features we plan to add in the future.

(back to top)

Built With

Front-end:

• 
• 
• 

Back-end:

• 
• 
• 
• 
• 

(back to top)

Getting Started

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

1. Follow the instructions for cloning and setting up the backend repo.
2. In a new terminal, clone the frontend repo.

   git clone https://github.com/veronicani/sharebnb-react.git

3. Install frontend dependencies.

   npm install

4. Run the app in the development mode.

   npm start

Open http://localhost:3000 to view it in your browser.

(back to top)

Roadmap

• Build MVP front end homepage
• Implement search feature
• Add test suite for implemented features
• Implement user authentication & authorization
  • Signup Form
  • Login Form
• Add test suite authentication & authorization
• More as needed

(back to top)

Contact

Veronica Ni - veronicani.dev - [email protected]

- linkedin.com/in/veronicani

Project Front End Link: https://github.com/veronicani/sharebnb-react

Project Back End Link: https://github.com/veronicani/sharebnb-flask

(back to top)

Acknowledgments

This is a project Jia Gan and I completed during a 1 week sprint at Rithm School. Many thanks to the staff team and their excellent curriculum and support!

• Co-authored with: Jia Gan
• Best-README-Template
• Img-shields
• simpleicons

(back to top)