https://github.com/claudiarojassoto/final-capstone-back-end
This Project is developed using Ruby on Rails, configured to serve as an API. This API is designed to facilitate reservations or appointments for test drives of cars. It leverages a PostgreSQL database to manage and store reservation data.
https://github.com/claudiarojassoto/final-capstone-back-end
active-record bcript controllers gems models postgresql-database routes rspec-testing rubocop-configuration
Last synced: about 2 months ago
JSON representation
This Project is developed using Ruby on Rails, configured to serve as an API. This API is designed to facilitate reservations or appointments for test drives of cars. It leverages a PostgreSQL database to manage and store reservation data.
- Host: GitHub
- URL: https://github.com/claudiarojassoto/final-capstone-back-end
- Owner: ClaudiaRojasSoto
- License: mit
- Created: 2023-10-23T13:52:45.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-21T00:04:38.000Z (over 1 year ago)
- Last Synced: 2025-03-29T22:21:59.702Z (3 months ago)
- Topics: active-record, bcript, controllers, gems, models, postgresql-database, routes, rspec-testing, rubocop-configuration
- Language: Ruby
- Homepage:
- Size: 3.02 MB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 final\_capstone\_back\_end ](#-final_capstone_back_end-)
- [🛠 ER Diagram ](#-er-diagram-)
- [💻 Link to Demo ](#-link-to-demo-)
- [💻 link to front end ](#-link-to-front-end-)
- [💻 link to Kanban board information ](#-link-to-kanban-board-information-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Database Setup](#database-setup)
- [Usage](#usage)
- [🔬 Running Tests ](#-running-tests-)
- [Test Suite](#test-suite)
- [💻 API Documentation ](#-api-documentation-)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
**final_capstone_back_end** The back-end component of this final capstone project is developed using Ruby on Rails, configured to serve as an API. This API is designed to facilitate reservations or appointments for test drives of cars. It leverages a PostgreSQL database to manage and store reservation data.
[Link to Demo](https://driver-front.onrender.com/)
[Link to Front End](https://github.com/ClaudiaRojasSoto/Final-Capstone-Front-End)
## 💻 link to Kanban board information
[Link to Kanban Board](https://github.com/ClaudiaRojasSoto/Final-Capstone-Back-End/projects/1)
[Initial state](https://github.com/ClaudiaRojasSoto/Final-Capstone-Back-End/issues/16)
This project was completed by two of the three original Team members:
- Claudia Rojas
- Pablo Bonasera
Technologies
Linters
- Rubocop
- [x] **Ruby on Rails**
- [x] **API Endpoint**
- [x] **Professional Documentation**
- [x] **Linting for Code Quality**
- [x] **Postgres Database**
- [x] **Git Version Control**
To get a local copy up and running, follow these steps:
### Prerequisites
Before you begin, ensure you have the following prerequisites installed on your system:
- Ruby: You need Ruby to run the Ruby on Rails application.
- Bundler: Bundler is used to manage gem dependencies for your Ruby project.
### Setup
In your terminal, navigate to the folder of your choice and clone the repository with the following commands:
```sh
cd my-folder
git clone https://github.com/ClaudiaRojasSoto/final_capstone_back_end.git
```
### Install
After cloning the project, change into the project directory:
```sh
cd final_capstone_back_end
```
Install this project with:
- gem install rails
- bundle install
### Database Setup
Create and migrate your database with:
```sh
rails db:create
rails db:migrate
```
### Usage
To run the project, execute the following command:
```sh
rails server
or
rails s
```
This should start your local server on http://localhost:3000/. Now, you can use the REST API client of your choice to interact with the API.
To run tests, navigate to the directory where the project is located on your machine, open your terminal, and follow these steps:
### Test Suite
This project contains a suite of unit tests which you can run to ensure everything is functioning as expected. To run these tests, you need RSpec installed.
To install RSpec if you haven't already, run:
```sh
gem install rspec
```
After you've installed RSpec, you can run the tests with:
```sh
rspec
```
[Run in Postman](https://winter-desert-419071.postman.co/workspace/My-Workspace~efdb5aba-9d35-41c3-848e-87060938ceb9/collection/19270283-b003a584-76ab-4464-8520-ecbd8d4677df?action=share&creator=19270283)
👤 **Claudia Rojas**
- GitHub: [@ClaudiaRojas](https://github.com/ClaudiaRojasSoto)
- LinkedIn: [@ClaudiaRojas](https://www.linkedin.com/in/claudia-rojas-soto/)
👤 **Pablo Bonasera**
- GitHub: [@PabloBona](https://github.com/PabloBona)
- LinkedIn: [Pablo Bonasera](https://www.linkedin.com/in/pablo-bonasera/)
- [ ] **Implement proper user authentication from the front-end to the server**
- [ ] **Add authorizations to users**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ClaudiaRojasSoto/final_capstone_back_end/issues).
If you like this project please feel free to send me corrections for make it better I would feel glad to read your comments.
And think If you enjoy gift me a star.
- Behance and Murat Korkmaz for the [original design](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign)
- Microverse for providing the opportunity to learn in a collaborative environment.
- React.js Documentation for valuable resources on React development.
- GitHub for version control and collaboration tools.
- **Can I use with a templeate your project?**
- Of course I would feel honored
- **Your project is free license?**
- Yeah, you can use it completely
This project is licensed under the MIT License - you can click here to have more details [MIT](MIT.md).