Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bhushan354/reservation-app-backend
The Full-Stack-Capstone-Backend is an API application for managing car rental vehicle databases.
https://github.com/bhushan354/reservation-app-backend
devise-jwt postgresql ruby-api rubyonrails
Last synced: about 1 month ago
JSON representation
The Full-Stack-Capstone-Backend is an API application for managing car rental vehicle databases.
- Host: GitHub
- URL: https://github.com/bhushan354/reservation-app-backend
- Owner: bhushan354
- License: mit
- Created: 2024-02-14T07:28:17.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-25T13:55:23.000Z (7 months ago)
- Last Synced: 2024-10-10T05:01:18.793Z (about 1 month ago)
- Topics: devise-jwt, postgresql, ruby-api, rubyonrails
- Language: Ruby
- Homepage:
- Size: 263 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Full-Stack-Capstone-Backend: Vehicle Reservation App
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Full-Stack-Capstone-Backend](#-full-stack-capstone-backend)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [Front-End-Link](#front-end-link)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐ Show your support ](#-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
# 📖 Full-Stack-Capstone-Backend
*The Full-Stack-Capstone-Backend* is an API application for managing car rental databases.
## 🛠 Built With
- ✅ Ruby
- ✅ Ruby on Rails
- ✅ Postgresql
- ✅ Linters
### Kanban Board
Link to Kanban Board: https://github.com/users/bhushan354/projects/6
Link to kanban board issue : https://github.com/bhushan354/Full-Stack-Capstone-Frontend/issues/12
Language
- Ruby-on-Rails
- 🔰 *Reserve a Vehicle for a Particular Date or Add a Vehicle for Reservations.*
## Front-End-Link
The front-end repo is available [here](https://github.com/bhushan354/Full-Stack-Capstone-Frontend/tree/dev)
*To get a local copy up and running, follow these steps.*
1. Download or clone this [repostory]([email protected]:bhushan354/Full-Stack-Capstone-Backend.git).
2. Provide a modern web browser.
### Prerequisites
*In order to run this project you need:*
- ✔ Ruby installed in your machine. you can download it from [here](https://www.ruby-lang.org/en/downloads/)
- ✔ IDE or a code editor installed in your machine.
- ✔ IRB.
- ✔ Get Postgresql up and running. you can download it from [here](https://www.postgresql.org/download/windows/).
- ✔ [Git](https://git-scm.com/downloads) installed in your machine.
- ✔ Sign in or sign up to your [Github](https://github.com/) account.
- ✔ A professional editer such as [VS Code](https://code.visualstudio.com/download).
- ✔ An Updated web browser such as Google Chrome, you can download it from [here](https://www.google.com/chrome/).
### Setup
- Clone this [repository]([email protected]:bhushan354/Full-Stack-Capstone-Backend.git) to your desired folder:
- Run this command in your command line interface:
```sh
cd [YOUR FOLDER]
git clone [email protected]:bhushan354/Reservation-App-Backend.git
cd Reservation-App-Backend
```
- open the folder in your code editor
- Update the config/database.yml with your database credentials under the development section
- Update the GEMFILE to match your version of ruby.
- Run these command in your command line interface:
```sh
sudo bundle install
rails db:drop
rails db:create
rails db:migrate
rails db:seed
```
- (Note : this 'sudo bundle install' command is only for UNIX and LINUX users if you are using windows run the terminal as a administrator and then run 'bundle install')
### Usage
- To run the project, execute the following command:
```sh
rails server
```
### Api-Documentation
- After running 'rails server' paste this link in your browser to see full Api-Documentation.
```sh
http://127.0.0.1:3000/api-docs/index.html
```
### Deployment
*This project is deployed by the author, no permission for deployment by any other client.*
👤 **Muhammad Umair Muqeem**
- GitHub: [@umair-rao](https://github.com/umair-rao)
- Twitter: [@umair_ra0](https://twitter.com/umair_ra0)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/engr-umair-muqeem/)
👤 *Eugene Omwomo*
- GitHub: [@Omwomo](https://github.com/Omwomo)
- Twitter: [@eugeneoduor9](https://twitter.com/eugeneoduor9)
- LinkedIn: [LinkedIn](https://linkedin.com/in/Omwomo)
👤 *Bhushan Deshmukh*
- GitHub: [@bhushan354](https://github.com/bhushan354)
- LinkedIn: [Bhushan Deshmukh](https://www.linkedin.com/in/bhushan-deshmukh-5777851b1/)
- *Add info about each category*
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/bhushan354/Full-Stack-Capstone-Backend/issues).
If you like this project, kindly drop a start ⭐ for the [repository]([email protected]:bhushan354/hello-rails-.git);
I would like to express my heartfelt gratitude to *Microvere* for the invaluable learning experience they have provided. Also I would like to thank to Stanley osagie for his support during react.
This project is [MIT](./LICENSE) licensed.