Catalog Of Things

📗 Table of Contents

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

📖 Catalog Of Things

Catalog Of Things is a Ruby-based project that is combined of several classes like Item with its relevant children such as Book, MusicAlbum, Movie, and Game, which is related together using Inheritance relationship. The Item class is also related some other classes like Author, Genre, Source, and Label that has the composition one-to-many relationship.

The project is a command-line project that prompts the user to first create the characteristics of an item and based on them, and then prompt the user to create the item of its desired substance.

🛠 Built With

Tech Stack

• ✅ Ruby.
• ✅ PostgresSQL
• ✅ Rubocop
• ✅ Rspec

Key Features

• Create 4 main characteristics for the item.
• Link the Item with some classes using composition relationship.
• Relate 4 other subitem for the Item class using inheritance.
• Run the program using a command-line interface.

(back to top)

Vedio Represntation

• In this vedio you can see that how the project works.

💻 Getting Started

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

1. Clone or download this repository in your desired local directory.

git clone https://github.com/M-Anwar-Hussaini/Catalog-Of-Things.git

2. Navigate to the project directory

cd Catalog-Of-Things

3. Open a terminal or command-prompt interface on the directory.

4. Install the dependencies of project

bundle install

5. Run the main file

ruby main.rb

Prerequisites

In order to run this project you need:

• Ruby installer
• Command Line interface.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/M-Anwar-Hussaini/Catalog-Of-Things.git

Install

Install this project with:

• ✅ Rubocop

  cd my-project
  gem install Rubocop

• ✅ Rspec

  cd my-project
  gem install rspec

Run tests

To run tests, run the following command go to the root directory of the project:

  rspec spec/*.rb

👥 Authors

👤 Mohammad Anwar Hussaini

• GitHub: @M-Anwar-Hussaini
• LinkedIn: Anwar Hussaini

👤 Abdelaziz Mahdi

• GitHub: @Abdelaziz-Mahdi
• Twitter: @_AbdelazizMahdi
• LinkedIn: in/abdelaziz-mahdi

👤 lRebornsl

• GitHub: @lRebornsl
• Twitter: @RebornsDev
• LinkedIn: Anthony Vásquez

(back to top)

🔭 Future Features

• Create GUI interface
• Make more validations on the methods.
• Provide more features using user story.

(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 kindly drop a star to this project.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing the opportunity to creat this project.

(back to top)

📝 License

This project is MIT licensed.