An open API service indexing awesome lists of open source software.

https://github.com/microverse-fullstack-program/catalog-of-things

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.
https://github.com/microverse-fullstack-program/catalog-of-things

rubocop rubocop-rspec ruby ruby-app ruby-gem

Last synced: 12 months ago
JSON representation

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.

Awesome Lists containing this project

README

          


Items Catalog


## 📗 Table of Contents

- [Catalog Ruby ](#catalog-ruby-)
- [🛠 Built With ](#-built-with-)
- [- Tech Stack ](#--tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites ](#prerequisites-)
- [Setup ](#setup-)
- [Installation ](#installation-)
- [Usage ](#usage-)
- [Run tests ](#run-tests-)
- [✍️ Authors ](#️-authors-)
- [👤 **Chere Lemma**:](#-Chere-Lemma)
- [👤 **Ismail ALi**:](#-ismail-ali)
- [👤 **Salomon Tshobohwa**:](#-Salomon-Tshobohwa)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [💖 Show your support ](#-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#--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

Testing

Linter

### 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](https://drive.google.com/file/d/17ggVrUlT_fhkL24Vz4LvHnhD1yQycWjs/view?usp=sharing)

(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](https://www.ruby-lang.org/en/) and [RSpec](https://rspec.info/) installed on your machine.

### Setup

Clone this repository to your desired folder:

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

```

### Installation

Install this project with:

```sh
bundle install
```

### Usage

To run the project, execute the following command:

```sh
ruby main.rb
```

### Run tests

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

```sh
cd spec
rspec classname_spec.rb
```

## Rspec Tests Screenshoot

(back to top)

## ✍️ Authors

### 👤 **Chere Lemma**

- GitHub: [@cherelemma](https://github.com/cherelemma)
- LinkedIn: [@chere-lemma27211613](https://www.linkedin.com/in/chere-lemma27211613)
- Twitter: [@twitterhandle](https://twitter.com/Chere21271613)


### 👤 **Ismail Changezi**

- GitHub: [@IsmailChangezi](https://github.com/IsmailChangezi)
- LinkedIn: [@ismailchangezi](https://www.linkedin.com/in/ismailchangezi/)
- Twitter: [@IsmailChangezi1](https://twitter.com/IsmailChangezi1)

### 👤 **Salomon Tshobohwa**

- GitHub: [@Tshobohwa](https://github.com/Tshobohwa)
- LinkedIn: [@tshobohwasalomon](https://www.linkedin.com/in/tshobohwasalomon/)
- Twitter: [@SalomonTshoboh1](https://twitter.com/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](../../../issues).

(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](./LICENSE) licensed.

(back to top)