Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/duanedave/bike-rental

Trek Bike Rental is a web application that enables users to rent bikes. Also, a user can sign in as an admin with delegated rights to perform CRUD operations on the database
https://github.com/duanedave/bike-rental

rails-api react react-router redux redux-toolkit theme-switcher

Last synced: 2 months ago
JSON representation

Trek Bike Rental is a web application that enables users to rent bikes. Also, a user can sign in as an admin with delegated rights to perform CRUD operations on the database

Awesome Lists containing this project

README

        



logo

TREK BIKE RENTALS

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [API Documentation](#api-documentation)
- [🚀 Live Demo](#live-demo)
- [Back-end Repository](#back-end-repository)
- [Kanban Board](#kanban-board)
- [💻 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)

# 📖 Trek Bike Rental

**Trek Bike Rental** is a rental web app designed to allow users rent a bike from Trek rental company.

## 🛠 Built With

### Tech Stack

> [React-Redux](https://guides.rubyonrails.org/) (React Redux is the official React UI bindings layer for Redux. It lets your React components read data from a Redux store, and dispatch actions to the store to update state.

Client

Server

Database

### Key Features

- **Add_bike**
- **Delete_bike**
- **Fetch/get_bike**
- **Authenticate_user**
- **Reserve_bike**

(back to top)

## API-Documentation

- [Link To Documentation](https://bike-rental-api.onrender.com/api-docs/index.html)

## 🚀 Live Demo

- [Live Demo Link](https://deploy-preview-31--rentbikes.netlify.app)

## Back-end Repository

[Backend Repo](https://github.com/DuaneDave/Bike-rental-api)

## Kanban Board

[Initial Kanbam Board link](https://user-images.githubusercontent.com/99597333/210737236-a5ccadaa-cae1-428d-af5d-70577c1b3620.png)

The collaborators to this project are;

- [@DuaneDave](https://github.com/DuaneDave)
- [@Haadiiii](https://github.com/Haadiiii)
- [@ChaabaneAnas](https://github.com/ChaabaneAnas/)
- [@principlebrothers](https://github.com/principlebrothers)

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

- [Node.js](https://nodejs.dev/en/) installed

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/DuaneDave/Bike-rental.git
```

### Install

Install this project with:

```sh
cd Bike-rental

npm install
```

### Usage

To run the project, execute the following command:

```sh
npm run dev
```

### Run tests

To run tests, run the following command:

```sh
npm run test or npm test
```

(back to top)

## 👥 Authors

👤 **Ernest Anyewe Adonu**

- GitHub: [@principlebrothers](https://github.com/principlebrothers)
- Twitter: [@adonu_ernest](https://twitter.com/adonu_ernest)
- LinkedIn: [Ernest Anyewe Adonu](www.linkedin.com/in/ernest-anyewe-adonu)

👤 **Haamid Ali**

- GitHub: [@Haadiiii](https://github.com/Haadiiii)
- Twitter: [@HaaDiii_99](https://twitter.com/HaaDiii_99)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/hamid-ali-01a872213/)

👤 **Obiebi David**

- GitHub: [@githubhandle](https://github.com/DuaneDave)
- Twitter: [@twitterhandle](https://twitter.com/dave_duane)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/david-obiebi)

👤 **Anas Chabaane**

- GitHub: [@githubhandle](https://github.com/ChaabaneAnas/)
- Twitter: [@twitterhandle](https://twitter.com/AnasChabaane)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/chaabaneanas/)

(back to top)

## 🔭 Future Features

- **Update_Reservation**
- **Update_Bike**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/DuaneDave/Bike-rental/issues/new)).

(back to top)

## ⭐️ Show your support

If you like this project, kindly give as a ⭐️

(back to top)

## 🙏 Acknowledgments

- We would like to thank [Microverse](https://www.microverse.org/) for inspiring this project
- A special appreciation to [Murat Korkmaz](https://www.behance.net/muratk) who design on [Behance](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign) inspired this project

(back to top)

## ❓ FAQ (OPTIONAL)

- **Why did you choose react?**

- [The biggest advantage of using it is that you can change any component at any point in time without affecting the other components. This alone results in widespread support among both clients and service providers.](https://blog.nextstacks.com/reasons-to-choose-react/#:~:text=Advantages%20of%20React%20over%20other%20frameworks%201%20Code,to%20Learn%20...%206%20Better%20Development%20Experience%20)

- **What is redux?**

- [Redux is simply a store to store the state of the variables in your app.](https://medium.com/swlh/what-is-redux-b16b42b33820)

(back to top)

## 📝 License

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

(back to top)