george827/Book-reservation-Back-End

Restaurant Table Reservation(Back End)

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • 🚀 Kanban board
    • 🚀 Api documentation
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Restaurant Table Reservation]

[Restaurant Table Reservation] holds the code for the backend of Restaurant table reservation app, The app allows user to register, add a table, reserve a table and delete the table or the reservation. The backend is built using Ruby On Rails and communicates with the frontend of the app to provide a seamless user experience. The backend includes functionality for user authentication, allowing only authorized users to use the application. It also includes a Postgresql database to store information about the Restaurant tables available, as well as information about user reservations.

🛠 Built With

Tech Stack

• Ruby
• Rails
• PostgreSQL

Server

• Rails

Database

• PostgreSQL

Key Features

• [Reserve a Table]
• [Add A Table]
• [Cancel Reservation]

(back to top)

Kanban board

• Link to kanBan Board

Initial state

(back to top)

API Documentation

• Check swagger documentation

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

• Install ruby on your computer or run it with docker.
• Install Postgrsql.
• Install rails (on your terminal): gem install rails

Setup

Clone this repository to your desired folder:

  git clone https://github.com/george827/Book-reservation-Back-End.git
  cd Book-reservation-Back-End/

Install

Install this project with:

  bundle install # installs necessary project gems

Usage

To run the project, execute the following command:

• First, change the username and password in the config/database.yml to your own username and password e.g.

username: postgres
password: 12345

• You may also need to change the ruby version in Gemfile depending on your current ruby version.

• Next, run the following commands to create a database, apply database migrations and run seeds file

rails db:create db:migrate db:seed

• Finally, spin up the rails server

  rails server

Run tests

To run tests, run the following command:

  rspec spec

Deployment

You can deploy this project using:

You can deploy this project on render:

• Follow the steps in this documentation to deploy a rails app.

(back to top)

👥 Authors

👤 George kinyanjui

• GitHub: @george827
• Twitter: @geok8376
• LinkedIn: George kinyanjui

👤 Wilson Kimiri

• GitHub: @willy836
• Twitter: @Kimiri836
• LinkedIn: Wilson Kimiri

👤 Harshita Jain

• GitHub: @harshitajain06
• Twitter: @harshitajain06
• LinkedIn: Harshita Jain

(back to top)

🔭 Future Features

• [Filter users by their roles]
• [Update table details]
• [Rate the service]

(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 you can give it a star ⭐️

(back to top)

🙏 Acknowledgments

• This design was inspired by Murat Korkmaz, the author of the original design.
• I would like to thank Microverse for the guidance and provision of Ruby on Rails learning materials.
• I would like to acknowledge my coding partners Harshita Jain and Wilson Kimiri for their contribution to this project. Thank you for your hard work and collaboration. You were instrumental in bringing this project to fruition.

(back to top)

📝 License

This project is MIT licensed.

(back to top)