PetBNB

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • Kanban Board
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [PetBNB]

[PetBNB] is a platform that allows users to rent rooms for their pets, similar to AirBNB. Users can add rooms to their profile for other users to rent and can make reservations for their pets to stay in a room. Additionally, users can add and remove pets, as well as add and remove rooms.

🛠 Built With

• Ruby on Rails
• PostgreSQL
• React
• HTML
• JavaScript
• CSS

Tech Stack

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Back-end

• RubyOnRails

Key Features

• [Rent rooms for pets]
• [Add rooms to profile for other users to rent]
• [Add and remove pets]

(back to top)

🚀 Live Demo

• You can see the live deploy of this app in this link

(back to top)

Kanba Board

• Link to our kanban board here
• Initial state of the Kanban board
• The project team had 4 members

💻 Getting Started

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Prerequisites

In order to run this project you need:

• npm install

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git git@github.com:Full-Stack-Capstone/petbnb-front.git

Install

Install this project with:

  cd my-project
  bundle install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm test

(back to top)

👥 Authors

👤 Diego Garcia

• GitHub: @taldr27
• LinkedIn: diegogarcial

👤 Erick Hans Martinez

• GitHub: @erickhansx
• Twitter: @TheErickHans
• LinkedIn: LinkedIn

👤 Tiago Lelinski Marin 🧑🏻‍💻

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: Tiago Lelinski

👤 Gabriel Andrade

• GitHub: @gandradep
• Twitter: @leribagandrade
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Users can leave a rating to each room]
• [Users can create a full personal profile]
• [Users can upload more than one image]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please leave a like on Github and share it with your friends.

(back to top)

🙏 Acknowledgments

I would like to thank Murat Korkmaz from Behance for the original design and layout of the app.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

ERD Diagram