📗 Table of Contents

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

📖 Catalog of my Things

In this project, we created a console app that will help you to keep a record of different types of things you own: books, music albums, and games. Everything will be based on the UML class diagram presented below. The data will be stored in JSON files.

Project Presentation Video

UML Diagram

🛠 Built With

Tech Stack

• Ruby
• SQL
• RSpec

Key Features

You can do the following with app:

• List all books
• List all music albums
• List all movies
• List of games
• List all genres
• List all labels
• List all authors
• List all sources
• Add a book
• Add a music album
• Add a movie
• Add a game
• Persist the data in a json file.

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

• An IDE e.g Visual studio code.
• A terminal.

Setup

Clone this repository to your desired folder or download the Zip folder:

git clone https://github.com/devMunyi/catalog-of-my-things.git

• Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd catalog-of-my-things

Install

To install all dependencies, run:

bundle install

Usage

To run the project, follow these instructions:

• After Cloning this repo to your local machine.
• To get it running on your machine, you may open the project on your IDE and open the terminal
• On the terminal you can run:

ruby main.rb

• After, you can follow along the app and run the appropriate option from list to interact with it.

Run tests

To run tests, run the following command:

rubocop

(back to top)

👤 Authors

👤 Samuel Munyi

• GitHub: devMunyi
• LinkedIn: Samuel Munyi
• Twitter: munyi_sam

👤 Zuhaib Amjad

• GitHub: Zuhaib042
• Twitter: Zuhaib042
• LinkedIn: zuhaib-amjad

👤 Kene Agagwu

• GitHub: kene-creator
• LinkedIn: kenechukwuagagwu

(back to top)

🔭 Future Features

• Implement more methods.
• Write Extra Message.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project and how I managed to build it!

(back to top)

🙏 Acknowledgments

• The original design ideal from Microverse💕.
• Project from Microverse Ruby / Database and Interviewing module.
• Thanks to the Microverse team for the great curriculum.
• Thanks to the Code Reviewer(s) for the insightful feedbacks.
• A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
• Hat tip to anyone whose code was used.

(back to top)

❓ FAQ

• Can I fork and reuse the repository

  • Yes please, feel free.

• Can I improve the repository, and my changes will be accepted if they are good?

  • Yes please, nice ideas are welcome, please.

(back to top)

📝 License

This project is MIT licensed.

(back to top)