BnB-homes 🏠️🛠️

BnB Homes is an app that allows users to view homes and reserve them for stays. It features a simple authentication and it is built with Rails and React (styled with Tailwind-CSS).

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
• 📓 API Documentation
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 BnB-homes-Backend

BnB-homes Backend is a Rails project which gives the API for the BnB-homes Frontend.

🛠 Built With

This app is built with Ruby on Rails and Postgresql.

Tech Stack

Ruby

Ruby on Rails

Postgresql

React

Redux

Key Features

• Authentication
• Authorization
• CRUD

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Mac or PC
• Install Ruby
• Install Rails
• Install Postgresql
• Install npm
• Understanding of Ruby

App Screenshot

Initial State of Kanban Board

Kanban

Setup

• Clone this repository to your desired folder:

   git clone https://github.com/peterdtitan/BnB-homes.git

• Navigate into the cloned folder

cd server

Install

Install this project with the following:

  bundle install

• Set up the database and change the username and password of your Postgres account in

config/database.yml

rails db:create db:migrate db:seed

• Start the server

rails s

• Run the tests

rspec ./spec/models

(back to top)

📓 API Documentation

• Run the server with rails s command
• The open API Documentation in your browser.

(back to top)

📖 BnB-homes Front-End

BnB-homes is a website where users can book a homes, cancel a booking. The user can also see the details of a homes.

🛠 Built With

Tech Stack

Client

• React.js
• Redux
• CSS

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• A web browser like Google Chrome.
• A code editor like Visual Studio Code with Git and Node.js.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Node.js and npm for package installation.

$ node --version && npm --version

Setup

Clone this repository using the GitHub link provided below.

Install

In the terminal, go to your file directory and run this command.

$ git clone https://github.com/peterdtitan/BnB-homes.git

• Navigate into the cloned folder

cd client

$ npm install

Usage

Kindly modify the files as needed.

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.

Run tests

To run tests, run the following command:

• To Test:-

   npm test

• To check Styelint error:-

   npx stylelint "\*_/_.{css,scss}"

• To check Eslint error:-

   npx eslint "**/*.{js,jsx}"

• To check webhint error:-

  npx hint .

(back to top)

👥 Authors

👤 Peter Okorafor

• GitHub: @peterdtitan
• LinkedIn: @Peter OKorafor

👤 Rishi Mishra

• GitHub: @Rishi Mishra
• LinkedIn: @Rishi Mishra

👤 Santosh Konappanavar

• GitHub: @Santosh-Konappanavar
• LinkedIn: @Santosh Konappanavar

👤 Karan Jain

• GitHub: @karanjain2212
• LinkedIn: @karanjain2212

(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 give a ⭐️

(back to top)

🙏 Acknowledgments

we would like to thank:

• Murat Korkmaz for a beautiful, efficient, and accessible user interface Design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)