belmeetmule / homely

Homely is a booking application that enable users to view list of houses, add and remove houses, book a visit and see bookings. Homely is designed in such a way that the front-end is decoupled from the back-end to make it scalable and maintainable. Built using Ruby on Rails back-end and React front-end.

📗 Table of Contents

• 📗 Table of Contents
• 📖 Hello React Frontend
  • Kanban Board
    • Screenshot of of the initial state of the Kanban board
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Hello React Frontend

Homely-frontend is an implemention of a connection between Ruby on Rails back-end and React front-end. Homely-backend handles the backend API, and Hello React Frontend handles the frontend UI to display a random greeting message.

Kanban Board

We are a team of 4 members.

• Wahaj Ali
• Mulugeta Belete
• Oshie
• Chukwuma Paul Mosanya

Kanban Board

Screenshot of of the initial state of the Kanban board

🛠 Built With

Tech Stack

Client

• Linters
• React
• Redux

Server

• ROR

Key Features

• Booking a house reseravtion.
• Add a new house.
• Delete a house.
• My reservations page only for the logged-in users.
• Responsive Design.
• State Management using Redux toolkit.
• Use latest ES6 modules.
• Design inspired by a Behance App design.
• Axios for making HTTP requests from the server.
• Use Swiperjs library to create the slider for the main-page.

(back to top)

🚀 Live Demo

• Homely

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

• API
• git
• node.js
• JavaScript

Setup

Clone this repository to your desired folder:

  git clone [e-mail]:Wahaj-Ali/homely-frontend.git
  cd homely-frontend

Install

Install thr project dependencies with:

  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run the test, execute the following command:

  npm test

Deployment

You can deploy this project using:

  npm run deploy

(back to top)

👥 Author

👤 Chukwuma Paul Mosanya

• GitHub
• Twitter
• LinkedIn

👤 Wahaj Ali

• GitHub
• Twitter
• LinkedIn

👤 Mulugeta Belete

• GitHub
• Twitter
• LinkedIn

👤 Akhror Valiev

• GitHub
• Twitter
• LinkedIn

(back to top)

🔭 Future Features

• Add more details about the houses.
• Add a search bar to search for houses.
• Update the style for a modern design.

(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 and want to support me make cooler projects Give this project a Star.

(back to top)

🙏 Acknowledgments

Thank you to Murat Korkmaz for the design ideas provided.

(back to top)

📝 License

This project is MIT licensed.

(back to top)