🏡🏖🗺ShareBnB 🌄🛫🚣‍♂️

Explore your next backyard destination.

View Demo

username: guest | demo password: password

Disclaimer: it might take 10-30 sec for the page to fully render

Table of Contents

1. About The Project
   • Learnings
   • Database Design
2. Built With
3. Getting Started
4. Authors
5. Acknowledgments

About the Project

ShareBnB is a full-stack application that enables users to login, manage their profile, browse and search for property rentals, book/reserve listings, post listings, and upload images securely in AWS. This project was built in January 2024 during a 4-day sprint at Rithm School.

This project offered the opportunity to build an entire full-stack application from scratch with the technologies of our choosing. We chose to build the backend with Flask for server-side routing and its integration with Jinja for accelerated development and library support with SQLAlchemy.

Frontend and backend hosted on Render and database hosted on ElephantSQL.

(back to top)

Learnings

• Project management and prioritizing key features under a deadline
• Delivering technical concepts with a lightning talk presentation
• Incorporating AWS S3 for secure cloud storage
• Documentation of bugs and resolution process
• Designing RESTful API routing
• Implementation of SQLAlchemy ORMs to manage database schemas and relationships
• Form validation and error handling with WTForms

Database Design

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

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

1. Clone repository.

   git clone https://github.com/crystal-tran/share-bnb.git
   

2. Create a virtual environment and install dependencies.

   python3 -m venv venv
   source venv/bin/activate
   pip install -r requirements.txt

3. Create and seed database.

   createdb sharebnb
   python seed.py

4. Run app

   flask run

5. View on http://localhost:5000/.

(back to top)

Authors

• Brandie Lucano : Frontend and backend co-author

Acknowledgments

• Rithm School
• Best-README-Template
• Markdown-Badges

(back to top)