billymohajeri/Final-Group-Capstone-Frontend

This is a Cottage bookings app that allows users to search a list of cottages available and make reservations for 24hs. This is the front-end repo.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
  • Setup
  • Prerequisites
  • Create database
• 👥 Authors
• 📊 Kanban Board
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Cottage booking app

Cottage booking app is a booking app that allows users to search a list of available cottages and make reservations. This is the frontend repository.

Backend repo is here

🛠 Built With

Tech Stack

Client

• Ruby
• Rails
• React
• Redux

Bundle

• WebPack
• NPM

Server

• Rails

Database

• PostgreSQL

Key Features

• Create new user
• Create new cottage
• Delete cottage
• Add reservation
• Display my reservations list

(back to top)

🚀 Live Demo

Live Demo

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

• Ruby on Rails installed and running. To get more information, read the installation guide.

• PostgreSQL installed and running.

Setup

Clone this repository to your desired folder:

Clone the back-end repo

git clone git@github.com:billymohajeri/Final-Group-Capstone-Backend.git

Clone the front-end repo

git clone git@github.com:billymohajeri/Final-Group-Capstone-Frontend.git

Install

Install the backend project with:

cd Final-Group-Capstone-Backend

bundle install to install all gems used.

rails db:create to create the database.

rails db:migrate to run the database migrations you created.

rails db:seed to add a new uer to the database.

rails s to run the dev server.

Go to http://localhost:3000/api-docs/index.html to see API documentation.

Install the frontend project with:

cd Final-Group-Capstone-Backend

npm install to install the app.

npm start ro run the app.

(back to top)

👥 Authors

👤 Billy Mohajeri

• GitHub: @BillyMohajeri
• Twitter: @BillyMohajeri
• LinkedIn: @BillyMohajeri

👤 Gaurav Gangwar

• GitHub: @gauravgangwarweb
• Twitter: @gauravgangwar501
• LinkedIn: Gaurav Gangwar

👤 Botlhale Setou

• GitHub: @Botlhale-Setou
• Twitter: @Botlhale_Setou
• LinkedIn: @botlhalesetou

(back to top)

📊 Kanban Board

• Link to Kanban Board: Kanban
• Initial state of Kanban board: Kanban Image
• We are a group of 3 persons.

(back to top)

🔭 Future Features

• Improve the application UI
• Add comment button
• Improve authentication system
• Authorization

(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 consider giving it a star.

(back to top)

🙏 Acknowledgments

• I would like to thank all code reviewers for making this project better.

• Original design idea by Murat Korkmaz on Behance.

📸 Photos:

• Houses Cottages at Free Stock Image by 👤 Arno Smit
• Wishbone Cottage, Malvern Hills at Unique Home Stays by 👤 Mark Watts

(back to top)

📝 License

This project is MIT licensed.

(back to top)