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.
Install / Use
/learn @belmeetmule/HomelyREADME
<a name="readme-top"></a>
📗 Table of Contents
<!-- PROJECT DESCRIPTION -->📖 Hello React Frontend <a name="about-the-project"></a>
<br>
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.
Screenshot of of the initial state of the Kanban board
🛠 Built With <a name="built-with"></a>
Tech Stack <a name="tech-stack"></a>
<details> <summary>Client</summary> <ul> <li><a href="https://github.com/microverseinc/linters-config/tree/master/ror">Linters</a></li> <li><a href="https://reactjs.org/">React</a></li> <li><a href="https://redux.js.org/">Redux</a></li> </ul> </details> <details> <summary>Server</summary> <ul> <li><a href="https://rubyonrails.org/">ROR</a></li> </ul> </details> <!-- Features -->Key Features <a name="key-features"></a>
- 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.
🚀 Live Demo <a name="live-demo"></a>
<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- GETTING STARTED -->💻 Getting Started <a name="getting-started"></a>
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
Setup
Clone this repository to your desired folder:
git clone git@github.com:Wahaj-Ali/homely-frontend.git
cd homely-frontend
Install
Install thr project dependencies with:
npm install
Usage <a name="usage"></a>
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
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- AUTHORS -->
👥 Author <a name="authors"></a>
👤 Chukwuma Paul Mosanya
👤 Wahaj Ali
👤 Mulugeta Belete
👤 Akhror Valiev
<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- FUTURE FEATURES -->🔭 Future Features <a name="future-features"></a>
- Add more details about the houses.
- Add a search bar to search for houses.
- Update the style for a modern design.
🤝 Contributing <a name="contributing"></a>
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- SUPPORT -->⭐️ Show your support <a name="support"></a>
If you like this project and want to support me make cooler projects Give this project a Star.
<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- ACKNOWLEDGEMENTS -->🙏 Acknowledgments <a name="acknowledgements"></a>
Thank you to Murat Korkmaz for the design ideas provided.
<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- LICENSE -->📝 License <a name="license"></a>
This project is MIT licensed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>