📗 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
• 📝 License

📖 Catalog of my things

Catalog of my things is an application that allows the user to add books, music albums, and games; this information is saved in separated JSON files, and the user can display this information in the console.

Adiotionally, there's an schema.sql with tables representing the classes and their associations.

These classes where made following this UML diagram:

🛠 Built With

Tech Stack

• Ruby.
• PostgreSQL.

Key Features

• Design classes following a UML diagram.
• Save and retrieve data from JSON files.
• Associations between classes.
• Represent the classes into SQL tables.
• Interactive UI.

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need to have:

• Installed Ruby.
• If you're using Windows, have installed WSL.
• If you're using MacOS, an option is using UTM.

Setup

To clone this repository to your desired folder, run the following command:

git clone git@github.com:Ruthmy/catalog-my-things.git

(back to top)

Usage

Initialize it with

ruby main.rb

(back to top)

Test

To run the tests try the following command:

rspec spec

(back to top)

👥 Authors

👤 Ruth Abreu

• GitHub: @Ruthmy
• Twitter @rury_exe
• LinkedIn: LinkedIn

👤 Alexandre Sales Medina Ferreira

• GitHub: @alexmedinasf
• LinkedIn: LinkedIn

👤 Manuel Sánchez

• GitHub: @Luffytaro22
• LinkedIn: Manuel Sánchez

(back to top)

🔭 Future Features

• Save the information in a PostgreSQL database.
• Let the user to remove and modify the information.

(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 please give it a star ⭐️

(back to top)

🙏 Acknowledgments

I would like to give credits to the following:

• Microverse for this readme template.

(back to top)

📝 License

This project is MIT licensed.

(back to top)