Thoth1111 / Program-Capstone-Backend

Rails API backend to Fullstack-Capstone-Project

📗 Table of Contents

• 📗 Table of Contents
• 🛵[Booking Vespa API]
  • Database Structure
  • 📄[Project Documentation]
  • Kanban Board
  • 🛠 Built With
  • Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

Booking Vespa Api 🛵

This project is designed for the reservation of fancy vespas. If you are preparing for a special day or event and you want a cool Vespa for it, this website is the best place for you. If you have a luxurious Vespa and want to make some extra money from it, you can add it to our website and others will be able to reserve it!

Here are some of the benefits of using our website:

• Wide selection of Vespas to choose from
• Competitive prices
• Easy and convenient booking process
• 24/7 customer support

The main features of this website are:

• Users can see details of all the Vespas.
• Users can reserve a Vespa for a special day.
• Users can add their own Vespas and remove them if they want to.

Database Structure:

Project Documentation 📄

• Front-end GitHub repository link👈
• Back-end API link 👈

Kanban Board

Kanban Board link

Initial state of the Kanban Board:

Final state of the Kanban Board:

Team members: 4 (Mohi Sadeghi, Alwyn Androvelle, Moses Wamae, Mladan Ilic)

(back to top)

Built With 🛠️

• Programming Languages: Ruby, SQL.
• Framework: Ruby on Rails.
• Database: PostgreSQL.
• Code Editor: VS Code.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• A web browser like Google Chrome.
• A code editor like Visual Studio Code with Git and Ruby.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Ruby installation.

$ ruby --version && irb

To install rails, in the terminal kindly run this command:

$ gem install rails

Setup

Clone the repository using the GitHub link provided below.

Install

In the terminal, go to your file directory and run this command.

$ git clone [e-mail]:djo1975/Program-Capstone.git

Usage

Kindly modify the files as needed.

Run locally

Make your way to the correct directory by running this command:

$ cd Program-Capstone

Install the required dependencies to run the project with this command:

$ bundle install

Setup the database, run:

$ rails db:create
$ rails db:migrate

Then run it in your browser with this command:

$ rails server

Run tests

To run tests, please run this command:

$ rspec

(back to top)

Authors

👤 Alwyn Androvelle

• Github: @Thoth1111
• Twitter: @androvelle
• LinkedIn: @Alwyn

👤 Mladan Ilic

• GitHub: @Ilic
• Twitter: @Ilic
• LinkedIn: @Ilic

👤 Mohi

• GitHub: @mohisa302
• Twitter: @Kholochelam
• LinkedIn: LinkedIn

👤 Moses Wamae

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

(back to top)

🚀 Future Features

• We'd implement a robust Role Based Access Control feature.
• We'd integrate a rating feature to allow users give ratings to Vespas booked.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Microverse

📝 License

This project is MIT licensed.

(back to top)