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.

Final Capstone Back End

📗 Table of Contents

• 📗 Table of Contents
• 📖 final_capstone_back_end
  • 🛠 ER Diagram
  • 💻 Link to Demo
  • 💻 link to front end
  • 💻 link to Kanban board information
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Database Setup
    • Usage
  • 🔬 Running Tests
    • Test Suite
  • 💻 API Documentation
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 Final Capstone Back End

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.

🛠 ER Diagram

💻 Link to Demo

Link to Demo

(back to top)

💻 Link to front end

Link to Front End

(back to top)

💻 link to Kanban board information

Link to Kanban Board

Initial state

This project was completed by two of the three original Team members:

• Claudia Rojas
• Pablo Bonasera

(back to top)

🛠 Built With

Tech Stack

Technologies

• Ruby on Rails

Linters

• Rubocop

Key Features

• Ruby on Rails
• API Endpoint
• Professional Documentation
• Linting for Code Quality
• Postgres Database
• Git Version Control

(back to top)

💻 Getting Started

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:

cd my-folder
git clone https://github.com/ClaudiaRojasSoto/final_capstone_back_end.git

Install

After cloning the project, change into the project directory:

cd final_capstone_back_end

Install this project with:

• gem install rails
• bundle install

Database Setup

Create and migrate your database with:

rails db:create
rails db:migrate

Usage

To run the project, execute the following command:

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.

(back to top)

🔬 Running Tests

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:

gem install rspec

After you've installed RSpec, you can run the tests with:

rspec

(back to top)

💻 API Documentation

Run in Postman

(back to top)

👥 Authors

👤 Claudia Rojas

• GitHub: @ClaudiaRojas
• LinkedIn: @ClaudiaRojas

👤 Pablo Bonasera

• GitHub: @PabloBona
• LinkedIn: Pablo Bonasera

(back to top)

🔭 Future Features

• Implement proper user authentication from the front-end to the server
• Add authorizations to users

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

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.

(back to top)

🙏 Acknowledgments

• Behance and Murat Korkmaz for the original design
• 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.

(back to top)

❓ FAQ (OPTIONAL)

• 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

(back to top)

📝 License

This project is licensed under the MIT License - you can click here to have more details MIT.

(back to top)

final-capstone-back-end's Issues

[1pt] Add Item

• When the user clicks the "Add item" link in the navigation panel they can see a form for adding a new item.

[2pt] Reservations List

• Design a page to list all the reservations of a user with the details of that reservation.

[2pt] Group Task - Setup Frontend repo

• Setup the Front End App
• Update readme

[2pt] Add Login And Signup

• The user logs in to the website, by typing the username and email.
• SignUp is possible too

[2pt] API Documentation

• Add documentation of the API.

[1pt] Group Task: Setup kanban board - final group capstone

Group members:

Facilitator: @PabloBona
Timekeeper: @alexmedinasf
Code checker: @ClaudiaRojasSoto
Task-assigner: @alexmedinasf , @PabloBona , @ClaudiaRojasSoto.

[2pt] Details Show Page

• When the user selects a specific item, they can see the details page.
• In the details page, the user can click the "Reserve" button (in the design you can see the "Configure" button - please replace it with the "Reserve" button).

[2pt] Navigation Panel

In the navigation panel, the user can see links to:

• Motorcycles/doctors/classes/items that you selected as a theme.
• "Reserve" form.
• "My reservations".
• "Add motorcycle/doctor/class/item that you selected as a theme" (the link is visible to everybody).
• "Delete motorcycle/doctor/class/item that you selected as a theme" (the link is visible to everybody).

[2pt] Delete item

• When the user clicks the "Delete item" link in the navigation panel they can see a list of all items with title and "Delete" button.
• When the user clicks the "Delete" button, the selected item is marked as removed and does not show on the main list anymore.

[2pt] Login And Sign-Up

• Users can access the website by entering their username and password.

[1pt] Delete reservations

• Design a delete button to delete a reservation from reservation list

[2pt] Define Models & Controllers

• Define Models
• Develop Controllers

Final group capstone: Kanban board

There are 3 members in our team:

- @alexmedinasf
- @PabloBona
- @ClaudiaRojasSoto

https://github.com/ClaudiaRojasSoto/Final-Capstone-Back-End

https://github.com/ClaudiaRojasSoto/Final-Capstone-Front-End

Screenshot:

[2pt] Add test on front end

• Snapshots and components for front-end

[2pt] Group Task: Establish Database Connection for Rails Project

• Set Up Database Connection
• Generate Migration Files

[2pt] Reserve an appointment

• To reserve an appointment, the user has to select a date and city (username and selected item are autofilled).
• Use the design based on the "Book a vespa test-ride" and add all necessary inputs.
• The user can also access the "Reserve" page from the navigation panel. In that case only username is autofilled.

[2pt] Add tests on back end

• Integration test for back-end

[2pt] Make the responsive design and Hero page

• Create a mobile and desktop version.
• Create a Hero page with slide

[2pt] Add a State To Change BG in reservation Page

• Use the design based on the "Book a vespa test-ride" green background and add all necessary inputs.
• Update Mobile to be responsive

[1pt] Group Task - Create ER Diagram

• Create the ER Diagram for the project

[2pt] Group Task - Setup Backend Repo

• Setup backend App

• Use Postgresql

• Add linters

• Update the readme file.

• Add Gems and enable CORS