- 📖 About the Project
- 💻 Getting Started
- 📃 Kanban Board
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- 📝 License
This web platform has been meticulously designed to offer users the ability to explore a diverse selection of houses, providing them with the freedom to reserve properties based on their preferences. Additionally, users can also leverage the platform to list their own properties, allowing other users to reserve them and generate extra income. To access the full range of features, users are encouraged to register an account, which grants them exclusive access to the website's functionalities using a unique username. The application comprises two main components: the cozy-homes-back-end and the cozy-homes-front-end. The cozy-homes-back-end houses the API backend, responsible for managing and retrieving data from the database in response to requests made by the frontend. This component is built using the robust Ruby on Rails API framework, ensuring a secure and efficient backend infrastructure.
On the other hand, the cozy-homes-front-end encompasses the captivating user interface of the website, providing an intuitive platform where users can seamlessly interact with the database. Developed using cutting-edge technologies such as ReactJS and Redux, the frontend offers a seamless and engaging user experience. With the powerful combination of a Ruby on Rails API backend and a dynamic ReactJS and Redux frontend, this web application delivers a compelling and feature-rich platform for users to explore, reserve, and list properties with utmost convenience and efficiency.
This project was implemented using:
Client
Server
Database
Key features of the application.
- Introducing a comprehensive full stack web application that empowers users with the ability to register and log in using a unique name, ensuring a personalized and secure experience.
- Upon registration, users gain access to a wide range of features, including the ability to seamlessly add, delete, and browse registered houses. With a diverse selection of houses available, users have the freedom to reserve any property that suits their preferences.
- To ensure a smooth user experience, the application provides publicly accessible API endpoints such as /api/v1/houses/ and /api/v1/houses/:id, enabling users to explore available houses effortlessly. Additionally, private API endpoints like /api/v1/reservations/:name are exclusively accessible to logged-in users, offering them the privilege to manage their reservations securely.
- Privacy is of utmost importance, and each user's reservation data remains confidential and inaccessible to others. Robust security measures are implemented to safeguard user information and ensure that data privacy is upheld at all times.
- The API itself is designed to deliver an exceptional user experience, returning specific error messages meticulously organized for different types of bad requests. This thoughtful approach enhances the overall usability and helps users easily identify and resolve any issues they may encounter.
- The website user interface follows carefully crafted design guidelines, ensuring an intuitive and visually appealing experience for users design guidelines. . The interface is designed with user convenience in mind, enabling effortless navigation and seamless interaction with the application's functionalities.
- Experience the power of this full stack web application, where user registration, house management, and secure reservations are seamlessly integrated to provide a truly exceptional and personalized user experience.
To clone the repository in local environment try following steps.
- A code editor like Visual Studio Code with Node.
You can check if Git is installed by running the following command in the terminal.
$ git --version
Likewise for node and yarn for package installation.
$ node --version && npm --version
Note: This project is built with Ruby version 3.0
Clone the repository using this link.
This website is applicable for both mobile and desktop version.
In the terminal, go to your file directory and run this command.
$ git clone https://github.com/HunterX-7/cozy-homes-front-end.git
In the terminal, run these commands to get into development.
$ cd cozy-homes-front-end
$ yarn install (install dependencies)
Note: You need to start the rails server first to ensure proper use of the frontend. So make sure you have followed the instructions available on cozy-homes-back-end.
$ yarn start
The Kanban Board made for this project can be found here.
You can see the initial status of our Kanban board here
👤 Francisco Quintero
- GitHub: @HunterX-7
- Twitter: @franquin07
- LinkedIn: Francisco Quintero
👤 Pierre Barba
- GitHub: @pierreBarba
- Twitter: @pierreBarba
- LinkedIn: @pierreBarba
👤 Juan Pablo Guerrero
- GitHub: @Juan Pablo Guerrero
- LinkedIn: @Juan Pablo Guerrero
👤 Gabriel Cilfone
- GitHub: Gabriel Cilfone
- LinkedIn: Gabriel Cilfone
- Add animation to create smooth user experience.
- Enable only admin users to add or delete houses.
- Implement proper user authentication from the front-end to the server.
- Add unit and integration tests to ensure the app's integrity.
Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.
Feel free to check the issues page.
Give a ⭐️ if you like this project!
We would like to give special thanks to:
Murat Korkmaz for the Original Page Design Idea.
This project is MIT licensed.