Items Catalog

📗 Table of Contents

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

Catalog Ruby

Items Catalog is a console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. It allows items record to be stored in JSON files and loaded on the program startup.

🛠 Built With

- Tech Stack

Client

• Ruby

Testing

• RSpec

Linter

• Rubocop

Key Features

• Create items like books, music albums, and game
• List added items
• Preserve each item's data in a separate JSON file
• Load items record from the file on start

(back to top)

👨‍💻 Video Documentation

Project Description Video

(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 and RSpec 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 main.rb

Run tests

To run tests, run the following command for each test file:

  cd spec
  rspec classname_spec.rb

Rspec Tests Screenshoot

(back to top)

✍️ Authors

👤 Chere Lemma

• GitHub: @cherelemma
• LinkedIn: @chere-lemma27211613
• Twitter: @twitterhandle

👤 Ismail Changezi

• GitHub: @IsmailChangezi
• LinkedIn: @ismailchangezi
• Twitter: @IsmailChangezi1

👤 Salomon Tshobohwa

• GitHub: @Tshobohwa
• LinkedIn: @tshobohwasalomon
• Twitter: @SalomonTshoboh1

(back to top)

🔭 Future Features

• Update selected Items
• Add genres/labels/authors
• Add 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)