Johnadibe / tour-reservation-app-api

🕹️🕹️ Tour Reservation API 🕹️🕹️

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Link to Api Docs
  • 🚀 Link to React Frontend
  • 🚀 Kaban Board
    • Kaban Board Initial State
  • ERD Diagram
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [tour-reservation-app-api]

[Tours Reservation APi] is the backend application designed to facilitate the process of booking and managing tour reservations. It allows users to browse available tours, select desired tour packages, specify booking details and receive confirmation for their reservations.

Tech Stack

• Ruby
• Rails
• PostgreSQL

Key Features

• [User Registration and Authentication]
• [Tour Listings]
• [Booking and Reservation Management]

(back to top)

🚀 Link to Api Documentation

To access the documentation, run the rails server using rails s and goto the above link

• Link to api-doc

(back to top)

🚀 Link to Front-end

• Link to Front-end

(back to top)

🚀 Kaban Board

• Kaban Board This is the link to the project management tool used to track the progress of the project.

Kaban Board Initial State

• Kaban Board Initial State This is the link to the project management tool used to track the progress of the project.

In this team, we are 4 in number,

• @Johnadibe
• @mrprotocoll
• @Hassaanjbaig-code
• @Donmark2k

(back to top)

🚀 ERD Diagram

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

1. git use the following link to setup git if you dont have it already installed on your computer

(install git)

2. Ruby use the following link to setup Ruby if you dont have it already installed on your computer

(install Ruby)

3. Rails use the following link to setup Rails if you dont have it already installed on your computer

(install Ruby)

4. PostgreSQL use the following link to setup PostgreSQL if you dont have it already installed on your computer

(install PostgreSQL)

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Johnadibe/tour-reservation-app-api

Install dependencies:

  cd tour-reservation-app-api
  bundle install

Database

Edit config/database.yml with your database connection info. Run the foolowing command

    rails db:create
    rails db:schema:load

Usage

The following command can be used to run the application.

  rails s

(back to top)

👥 Authors

👤 mrprotocoll

• GitHub: @mrprotocoll
• Twitter: @dprotocoll
• LinkedIn: @mrprotocoll

👤 Hassaan Baig

• GitHub: @Hassaan Baig
• LinkedIn: Hassaan Baig

👤 John Adibe

• GitHub: @Johnadibe
• Twitter: @JohnAdibe2
• LinkedIn: @John Adibe

👤 Chukwuemeka Ochuba

• GitHub: @Donmark2k
• Twitter: @donmark2k
• LinkedIn: LinkedIn

🔭 Future Features

• [Add Admin dashboard]
• [Add payment system]
• [Cancel reservation]

(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 don't forget to follow the contributors and give it a star.

(back to top)

🙏 Acknowledgments

We would like to appreciate Microverse for providing the resources and the platform for us to be a Professional full-stack developer, and We would specially thank Murat Korkmaz who is the original author of this design

(back to top)

📝 License

This project is MIT licensed.

(back to top)