Skip to content

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).

License

Notifications You must be signed in to change notification settings

peterdtitan/BnB-homes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation


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

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

    App

    Initial State of Kanban Board

    kanban

    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

    (back to top)

    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

    πŸ’» 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

    πŸ‘€ Rishi Mishra

    πŸ‘€ Santosh Konappanavar

    πŸ‘€ Karan Jain

    (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:

    (back to top)

    πŸ“ License

    This project is MIT licensed.

    (back to top)

    About

    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).

    Resources

    License

    Stars

    Watchers

    Forks

    Releases

    No releases published

    Packages

    No packages published

    Contributors 4

    •  
    •  
    •  
    •