Items Catalog

📗 Table of Contents

• Catalog Ruby
  • 🛠 Built With
    • - Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Installation
    • Usage
    • Run tests
  • ✍️ Authors
    • 👤 Walid Kabboussa:
    • 👤 Chere Lemma:
    • 👤 Akpan Daniel:
  • 🔭 Future Features
  • 🤝 Contributing
  • 💖 Show your support
  • 🙏 Acknowledgments
  • 📝 License

Catalog Ruby

Items Catalog console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games.

🛠 Built With

- Tech Stack

Client

• Ruby

Testing

• RSpec

Linter

• Rubocop

Key Features

• Create items like book, music album and game
• List added items
• Preserve each item's data in a separate JSON file

(back to top)

👨‍💻 Video Documentation

Video Documentation

(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 Ruby installed on your machine.

Setup

Clone this repository to your desired folder:

  git clone https://github.com/Microverse-Fullstack-Program/catalog-of-things.git

cd catalog-of-things

### Installation <a name="installation"></a>

Install this project with:

```sh
  bundle install

Usage

To run the project, execute the following command:

  ruby menu.rb

Run tests

To run tests, run the following command:

  cd spec
  rspec classname_spec.rb

Rspec Tests

(back to top)

✍️ Authors

👤 Chere Lemma

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

👤 Walid Kabboussa

• GitHub: @Hisoka37
• Twitter: @KBwalid9
• LinkedIn: Walid Kabboussa

👤 Kagheni Mbale Christian

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Update selected Items
• Add genres/labels
• Add Movies Items

(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 consider giving it a 🌟.

(back to top)

🙏 Acknowledgments

We would like to thank microverse for serving this opprtunity.

(back to top)

📝 License

This project is MIT licensed.

(back to top)