Catalog App

📗 Table of Contents

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

📖 Catalog App

Catalog App is a console app that will help you 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 here. The data is stored in JSON files but it also counts with a database tables structure that could be implemented.

🛠 Built With

Tech Stack

Ruby

• Ruby
• Ruby styles guide
• Ruby linters (Rubocop)

Rspec

• Guide

PostgreSQL

• Documentation

Key Features

• Class Item is the parent class for book, game, and MusicAlbum

• Private methods

• The app.rb serve as the console app entry-point

• Basic UI when you run the main.rbfile

• main.rb define the entry point

• Unit tests

• Database schema

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

This repository includes files with ruby lenguage and SQL.

Prerequisites

In order to run this project you need to have Ruby installed, check this documentation in order to know how to install it.

Setup

Clone this repository to your desired folder:

  cd my-folder 
  git clone https://github.com/AndreaM2429/Catalog_App

Usage

To run the app in the basic console UI, execute the command:

  ruby main.rb

To check the linters you can use the command:

  rubocop

To fix the linter use:

  rubocop -A

Tests

To run the tests use the command:

  rspec

(back to top)

👥 Author

👤 Andrea Manuel

• GitHub: @AndreaM2429
• Twitter: @AndreaManuelOr1
• LinkedIn: Andrea Manuel

👤 Cesar Herrera

• GitHub: @CesarHerr
• LinkedIn: Cesarherr

👤 Nicolas Bolañez

• GitHub: @Zven94
• LinkedIn: Nicolas Bolañez

(back to top)

🔭 Future Features

• Implement the Source and Movie classes

(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 you could clone the repo and work with it or do the changes in a new branch. Also you could let a message with your thoughts.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing the necessary resources and all the effort from each member to complete this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)