An open API service indexing awesome lists of open source software.

https://github.com/alusp/book_an_appointment_back_end

Bike Rental is available 24/7. Allow users to Rent their next bike anytime in any of our cities. Rent up to four bikes at once on one account via the App.
https://github.com/alusp/book_an_appointment_back_end

Last synced: over 1 year ago
JSON representation

Bike Rental is available 24/7. Allow users to Rent their next bike anytime in any of our cities. Rent up to four bikes at once on one account via the App.

Awesome Lists containing this project

README

          




Bike Rental Back End

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 Bike Rental Back End

> Bike Rental Available 24/7. Allow users to Rent your nextbike anytime in either of our available cities. Rent up to four bikes at once on one account via the App.

## 🛠 Built With

### Tech Stack

> Ruby on Rails, a full-stack framework. It ships with all the tools needed to build amazing web apps on both the front and back end. Rendering HTML templates, updating etc

Server

Database

### Key Features

> Describe between 1-3 key features of the application.

- **Sign In**
- **Add Bikes**
- **Get Bikes**
- **Removes Bikes**
- **Reserve Bikes**

(back to top)

## API Documentation

- [Here](https://book-appoint.onrender.com/api-docs/index.html)

## 🚀 Live Demo

- [Live Demo Link](https://book-appoint.onrender.com/api/v1/bikes)

## 🚀 Front End Repo

- [Here](https://github.com/samiullah997/book_an_appointment_front_end)

(back to top)

## 💻 Getting Started

> Describe how a new developer could make use of your project.

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

### Prerequisites

In order to run this project you need:

```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/Alusp/book_an_appointment_back_end
```

### Install

Install this project with:

```sh
cd my-project
gem install
```

### Usage

To run the project, execute the following command:

```sh
rails server
```

### Run tests

To run tests, run the following command:

Example command:

```sh
rspec ./spec/models/
```

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👤 **Alusine Jalloh**

- GitHub: [@Alusp](https://github.com/Alusp)
- LinkedIn: [@alusine-jalloh](https://www.linkedin.com/in/alusine-jalloh)
- Twitter: [@aseni_jalloh](https://twitter.com/aseni_jalloh)

👤 **Sami Ullah**

- GitHub: [@samiullah997](https://github.com/samiullah997)
- Twitter: [@samiullahk997](https://twitter.com/samiullahk997)
- LinkedIn: [Samiullah Khan](https://www.linkedin.com/in/samiullah-khan-2702b7171/)

👤 **Alfred Kinyua**

- GitHub: [@AlfredKInyua](https://github.com/Alfred-KInyua)
- Twitter: [@alfkinyua](https://twitter.com/alfkinyua)
- LinkedIn: [@AlfredKInyua](https://www.linkedin.com/in/alfred-kinyua/)

(back to top)

## 🔭 Future Features

> Describe 1 - 3 features you will add to the project.

- [ ] **Payment Feature**
- [ ] **Book date and Return Date**
- [ ] **GPS Trackers**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project

If you like this project...

(back to top)

## 🙏 Acknowledgments

> The design is provided by Murat Korkmaz on Behance.

I would like to thank Microverse for inspiring this project

(back to top)

## ❓ FAQ (OPTIONAL)

> Add at least 2 questions new developers would ask when they decide to use your project.

- **[Question_1]**

- [Answer_1]

- **[Question_2]**

- [Answer_2]

(back to top)

## 📝 License

This project is [MIT](./MIT.md) licensed.

(back to top)