Catalog

This is an app to show a catalog of my things

Microverse README Template

📗 Table of Contents

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

📖 [Catlog]

In this project, we have created a console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. Everything will be based on the UML class diagram presented below. The data will be stored in JSON files but we also prepare a database with tables structure analogical to your program's class structure.

• Create a main.rb file that will serve as your console app entry-point.
  • Present the user with a list of options to perform.
  • Let users choose an option.
  • If needed, ask for parameters for the option.
  • Have a way to quit the app.
• The following options should be available:
  • List all books
  • List all music albums
  • List all movies
  • List of games
  • List all genres (e.g 'Comedy', 'Thriller')
  • List all labels (e.g. 'Gift', 'New')
  • List all authors (e.g. 'Stephen King')
  • List all sources (e.g. 'From a friend', 'Online shop')
  • Add a book
  • Add a music album
  • Add a movie
  • Add a game
  • To exit the app

Video Demo

🛠 Built With Ruby

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Setup

Clone this repository:

  git clone https://github.com/TracyMuso/Catalog

Go to your project

  cd my-folder

Install

Important! You need to have ruby and rspec installed in your computer

Install this project with:

  cd my-project
  gem install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run tests, run the following command:

  rspec spec spec/genre_spec.rb

👥 Authors

Mention all of the collaborators of this project.

👤 Megha Bodke

• GitHub: @megha-n-bodke
• LinkedIn: Megha Bodke

👤 Tracy Musongole

• GitHub: @TracyMuso
• LinkedIn: Tracy Musongole

👤 George.W.Kidde

• GitHub: @kidde60
• LinkedIn: William.G.Kidde

👤 Josue Batey

• GitHub: @Bateyjosue
• LinkedIn: Bateyjosue

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

• Thanks to Microverse for giving this opportunity to learn ...
• Code Reviewers & Coding Partners.
• Hat tip to anyone whose code was used.
• Inspiration.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)