Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/duanedave/bike-rental-api
https://github.com/duanedave/bike-rental-api
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/duanedave/bike-rental-api
- Owner: DuaneDave
- License: mit
- Created: 2023-01-04T10:22:42.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-22T19:40:38.000Z (almost 2 years ago)
- Last Synced: 2024-10-24T14:24:19.011Z (2 months ago)
- Language: Ruby
- Size: 669 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Microverse README Template
# 📗 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 API** is an API designed to allow users create a bike rental web app for any bike rental company.The database designed is based on this schema 
> [Ruby on Rails](https://guides.rubyonrails.org/) (simplify as Rails) is a server-side web application framework written in Ruby under the MIT License. Rails is a model–view–controller (MVC) framework, providing default structures for a database, a web service, and web pages. It encourages and facilitates the use of web standards such as JSON or XML for data transfer and HTML, CSS and JavaScript for user interfacing.
Server
Database
> Describe between 1-3 key features of the application.
- **Add_bike**
- **Delete_bike**
- **Fetch/get_bike**
## API-Documentain
- [Link To Documentation](https://bike-rental-api.onrender.com/api-docs/index.html)
- [Live Demo Link](https://bike-rental-api.onrender.com/api/v1/bikes)
## Front-end Repository
[Front-end Repo](https://github.com/DuaneDave/Bike-rental)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md#toolsonunixbasedsystems)
- [Ruby and Rails on you operating system eg. for Ubuntu 20.04](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-20-04)
- [Node.js](https://nodejs.dev/en/) installed
- [PostgreSQL](https://www.postgresql.org/) database installed
**Note:** It is recommended you use the latest version of Ruby[3.1.3] and Rails[7.0]
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/DuaneDave/Bike-rental-api.git
```
### Install
Install this project with:
```sh
cd Bike-rental-api
bundle install
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
### Run tests
To run tests, run the following command:
```sh
bin/rails rspec spec
```
### Deployment
You can deploy this project using:
👤 **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/)
- [x] **Update_Reservation**
- [x] **Update_Bike**
- [x] **API_Token**
- [x] **User_Authorization**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/DuaneDave/Bike-rental-api/issues/new)).
If you like this project, kindly give as a ⭐️
## 🙏 Acknowledgments
[the design](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign) provided by [Murat Korkmaz](https://www.behance.net/muratk) on Behance.
We would like to thank [Microverse](https://www.microverse.org/) for inspiring this project
- **Is Rails still relevant?**
- [Yes, Rails is still popular among developer](https://blog.railwaymen.org/is-ruby-on-rails-dead)
- **Is it easy to learn Ruby on Rails**
- [It is very easy to learn compared to most of the programming languages](https://careerkarma.com/blog/why-learn-ruby-on-rails/)
This project is [MIT](./LICENSE) licensed.