leboroz / catalog-of-my-things

Catalog of my things

In this project, we created a console app that helps you keeping a record of different types of things you won: 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 prepared a database with tables structure analogical to your program's class structure.

Built With

• Ruby
• Rspec, Rspec utils
• Git, Gitflow

Getting Started

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

Prerequisites

• Git
• Ruby

Setup

• run

$ git clone [email protected]:Leboroz/catalog-of-my-things.git

$ cd catalog-of-my-things

Install

• run

$ bundle install

this will install all the packages necessaries to run the app and tests

Usage

• run

$ ruby main.rb

The console app, at the start, should:

• 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 are 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

Run tests

run

$ rspec

Authors

👤 Lisandro Seia

• GitHub @lisandroseia
• LinkdIn LinkedIn

👤 Leonardo Albornoz

• GitHub @Leboroz
• Twitter @Leboroz
• LinkedIn Leonardo Albornoz

👤 Nicolas Gonzalez

• GitHub @Nicolaswg
• LinkdIn LinkedIn

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc

📝 License

This project is MIT licensed.