arnoldnekemiah/Catalog-Of-My-Things

A console app that is used to keep record of different types of things I own: books, music albums, movies, and games. Everything is based on the UML class diagram presented below. The data is stored in a JSON files but I also prepared a database with tables structure analogical to this program's class structure.

📗 Table of Contents

• 📗 Table of Contents
• [📖 [Catalog-Of-My-Things ] ](#-catalog-of-my-things -)

  • 🛠 Built With

    • Tech Stack
    • Key Features
      • 🚀 Live Demo

  • 💻 Getting Started

    • Prerequisites
    • Setup
    • Install
    • Usage

  • 👥 Authors

  • 🔭 Future Features

  • 🤝 Contributing

  • ⭐️ Show your support

  • 🙏 Acknowledgments

  • ❓ FAQ (OPTIONAL)

  • 📝 License

📖 [Catalog-Of-My-Things ]

Project description.

[Catalog Of My Things ] is a Ruby program that uses classes, inheritance, encapsulation and abstraction to manage a users's catalog. It is a console app that is used to keep record of different types of things I own: books, music albums, movies, and games. Everything is based on the UML class diagram presented below. The data is stored in a JSON files but I also prepared a database with tables structure analogical to this program's class structure.

🛠 Built With

Tech Stack

The tech stack used in this project includes.

Ruby

• Ruby
• PostgreSql

Key Features

Key features of the application include.

• [OOP in Ruby]
• [Decorators Design Parterns]
• [Associations Design Parterns]

(back to top)

🚀 Presentation video https://drive.google.com/file/d/166RT38BhrBXrWi-6zMvUB06XFARjpXQh/view?usp=sharing

🚀 Live Demo

• Presentaion video Link

💻 Getting Started

Install Ruby, open the Ruby Interactive terminal, and run the codes.

Prerequisites

In order to run this project you need:

• [Install Ruby]

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Chudisoft/Catalog-Of-My-Things.git

Install

Install this project with:

• Ruby

Usage

To run the project, execute the following command:

• [ruby main.rb]

(back to top)

👥 Authors

Collaborators of this project include:

👤 Christopher Uduekwe

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 IKONDE NEKEMIAH ARNOLD

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Fatima Najafi

• GitHub: @fatima-najafi
• Twitter: @fatima-najafi
• LinkedIn: @fatima-najafi

(back to top)

🔭 Future Features

Features of this project include.

[Implement classes and objects in Ruby.] [Implement encapsulation and inheritance with Ruby.]

(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 a star to this repository

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for this wonderful opportunity.

(back to top)

❓ FAQ (OPTIONAL)

2 questions new developers would ask when they decide to use this project.

• [What languages where used?]

  • [Ruby]

• [What git control system was used?]

  • [Github]

(back to top)

📝 License

This project is MIT licensed.

(back to top)