Catalog Of My Things

(Project UML)

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Presentation
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Catalog Of My Things

Catalog of My Things is a Ruby capstone project that demostrates the core principles of OOP and lets users create a catalog of their things via the command line. The options are book, genre, label, author, game, and music album which are classes with defined methods.

🛠 Built With

Tech Stack

Client

• Ruby

Key Features

• Six classes and demonstration of inheritance
• Modular code and features
• Test coverage for class/methods

(back to top)

🚀 Live Presentation

• Live Presentation Link

(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:

 brew install ruby (on Mac OS)

Setup

Clone this repository to your desired folder:

Install

Install this project with:

  cd catalog-of-my-things
  bundle install

Usage

To run the project, execute the following command:

  ruby ./main.rb

Run tests

To run tests, run the following command:

  rspec

Deployment

This project is run locally on the CLI and has no deployments.

(back to top)

👥 Authors

👤 Peter Okorafor

• GitHub: @peterdtitan
• Twitter: @PeterDeTitan
• LinkedIn: Peter OKorafor

👤 Precious Betine

• GitHub: @preciousbetine

👤 Yidnekachew Kassahun Kibret

• GitHub: @Yidnekachew-cmd

(back to top)

🔭 Future Features

There will be no future features available for this project as it will be deprecated soon. However, the following may be done:

• Code Refactoring
• Modification of modules
• More unit tests.

(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 give it a star and follow me.

(back to top)

🙏 Acknowledgments

I would like to thank (Microverse)[https://github.com/microverseinc] for providing the learning support as well as all collaborators on this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)