ethred / catalog

📗 Table of Contents

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

📖 Catalog-of-Things

Catalog of Things is a ruby written console application which delivers a detailed method to create different objects of a catalog such as item, books, label, music album, genre, game, author information. The primary purpose of the program is to explore the object oriented programming. Here we have demonstrated the creation of objects, adding the basic UI, unit test the methods and preserve the data in json files.

🛠 Built With

Tech Stack

Client

• None

Server

• Ruby

Database

• None

Key Features

• DRY method
• Catalog of different things like: Book, Music and Game
• Add Storage feature
• Unit Test

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

Setup

Clone this repository to your desired folder:

https://github.com/AliRezaBmeDu/catalog.git

Install

  cd catalog
  bundle install

Usage

To run the project, execute the following steps:

  ruby main.rb

Test

To run the unit test files, run the following command in the terminal:

  rspec

(back to top)

👥 Authors

👤 Mohammad Ali Reza

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

👤 Redwan Mohammed-Nur

• GitHub: @ethred
• Twitter: @redwanthr
• LinkedIn: Redwan Tahir

👤 Vikas Chib

• GitHub: @vikas924
• Twitter: @vikas410190
• LinkedIn: Vikas Singh

(back to top)

🔭 Future Features

• Make it viable to a web app

(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 ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank all the documents provided by microverse.

(back to top)

📝 License

This project is MIT licensed.

(back to top)