The Catalog

The Catalog

# 📗 Table of Contents

• 📗 Table of Contents
• 📖 The Catalog
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 The Catalog

The Catalog project is an app developed to simulate the operations of a real-world library within OOP University. This app is designed to utilize Object-Oriented Programming (OOP) principles to create a comprehensive system that captures vital library processes.

🛠 Built With

Tech Stack

• Ruby

Key Features

• Create necessary associations within the project to lay the foundation for the user interface development planned for the next milestone.
• Use of the decorator pattern, which is employed to add additional functionalities to objects dynamically.
• Add a console User Interface to run the application.
• Refactor the entire application to apply SOLID, YAGNI, KISS, & DRY principles.
• Preserve all data using files with JSON format.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Install Ruby

Setup

  cd my-folder
  git clone https://github.com/Alejandroq12/the-catalog.git

Install

This project does not require additional dependencies, just Ruby interpreter. However, it uses RuboCop as a linter and you should set it up as well.

bundle install

Usage

To run the project, navigate to the project directory and execute the following command:

  ruby main.rb

Run tests

To run tests, run the following command:

Run the following command

rubocop

Deployment

You can deploy this project using:

Not available at the moment.

(back to top)

👥 Authors

👤 Julio Quezada

• GitHub: Alejandroq12
• Twitter: @JulioAle54
• LinkedIn: Julio Quezada

👤 Juan Carlos Muñoz

• GitHub: @jcmunav63
• Twitter: @jcmunav63
• LinkedIn: @juan-carlos-muñoz-navarrete

(back to top)

🔭 Future Features

• I will add a user interface.
• I will preserve data.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

If you like this project please give a star. Thanks in advance.

(back to top)

🙏 Acknowledgments

I would like to thank all of my colleagues who inspire to do my best everyday.

(back to top)

❓ FAQ

Did you create this project from scratch?

• Yes, and for that reason, I have extensively learned about Object-Oriented Programming, including key concepts such as association, aggregation, and composition, as well as skills in running scripts, obtaining user input, adhering to best practices, and applying SOLID principles.

(back to top)

📝 License

This project is MIT licensed.

(back to top)