https://github.com/ha-manel/luxy-rides-api
This project is made for the reservation of fancy cars. If you're preparing for a special day/event and you want a cool car for it this website is the best place for you. If you have a luxurious car and want to make some extra money from it, you can add that to our website and others will be able to reserve it!
https://github.com/ha-manel/luxy-rides-api
bootstrap5 css react reservations ruby-on-rails
Last synced: 4 months ago
JSON representation
This project is made for the reservation of fancy cars. If you're preparing for a special day/event and you want a cool car for it this website is the best place for you. If you have a luxurious car and want to make some extra money from it, you can add that to our website and others will be able to reserve it!
- Host: GitHub
- URL: https://github.com/ha-manel/luxy-rides-api
- Owner: ha-manel
- Created: 2022-09-21T11:12:10.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2022-12-16T11:49:08.000Z (over 2 years ago)
- Last Synced: 2025-01-12T02:52:19.392Z (5 months ago)
- Topics: bootstrap5, css, react, reservations, ruby-on-rails
- Language: Ruby
- Homepage: https://luxy-ride-frontend.vercel.app/
- Size: 88.9 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Luxy Rides API
This project is made for the reservation of fancy cars. If you're preparing for a special day/event and you want a cool car for it this website is the best place for you. If you have a luxurious car and want to make some extra money from it, you can add that to our website and others will be able to reserve it!
Main features of this website are:
- Users can see details of all the cars.
- Users can reserve a car for a special day (a car that hasn't been reserved yet).
- Users can add their own cars and remove them if they want to.
## Database Structure:
## Project Documentation 📄
- Live demo [link](https://luxy-ride-frontend.vercel.app/)👈
- API deployment [link](https://luxy-rides.onrender.com/api-docs/index.html)👈
- Front-end GitHub repository [link](https://github.com/ha-manel/Luxy-Rides-Frontend)👈
## Kanban Board
### Kanban Board [link](https://github.com/ha-manel/Luxy-Rides-API/projects/1)
### Initial state of the Kanban Board:
### Team members: 3 (Hammouche Manel, Hammad Siddique, Toussaint Saraza)
## 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 [email protected]:ha-manel/Luxy-Rides-API.git
```
### Usage
Kindly modify the files as needed.
### Run locally
Make your way to the correct directory by running this command:
```
$ cd Luxy-Rides-API
```
Install the required dependencies to run the project with this command:
```
$ bundle install
```
Setup the database, run:
```
$ rails db:create
$ rails db:migrate
$ rails db:seed
```
Then run it in your browser with this command:
```
$ rails server
```
### Run tests
To run tests, please run this command:
```
$ rspec
```
## Authors
👤 **Manel Hammouche** 
- 
[ha-manel](https://github.com/ha-manel)
- 
[ha_manel_](https://twitter.com/ha_manel_)
- 
[Manel Hammouche](https://www.linkedin.com/in/manel-hammouche/)
👤 **Toussaint Saraza**
- [sarazaToussaint](https://github.com/sarazaToussaint)
- [toussaintSaraz1](https://twitter.com/ToussaintSaraz1)
- [Toussaint Saraza](https://www.linkedin.com/in/toussaintsaraza/)
👤 **Hammad Siddique**
- [HammadSiddique](https://github.com/HammadSiddique)
- [hs_devv](https://twitter.com/hs_devv)
- [HammadSiddique](https://www.linkedin.com/in/-hammadsiddique/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- [Microverse](https://www.microverse.org/)
## 📝 License
This project is MIT licensed.