Catalog of my things

📗 Table of Contents

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

📖 Catalog of my things

Catalog of my things is a project where we create 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 is stored in JSON files but we also prepare a database with tables structure analogical to the program's class structure.

🛠 Built With

Tech Stack

Client

• Ruby

Key Features

• This project use linters
• This project implements unit tests
• This project use Gitflow workflow

Back to top

💻 Getting Started

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

Prerequisites

• You'll need any code editor

Setup

Clone this repository to your desired folder:

  git clone git@github.com:NicolasAndrehh/Things-Catalog.git
  cd Things-Catalog

Usage

To run the project, execute the following command:

  ruby main.rb

👥 Authors

👤 Nicolas Olaya

• GitHub: @NicolasAndrehh
• Twitter: @nicolasolaya22
• LinkedIn: LinkedIn

👤 Dico Diaz Dussan

• GitHub: @dicodiaz
• LinkedIn: Dico Diaz Dussan
• Portfolio: portfolio.dicodiaz.com.co

👤 Rashed Arman

• GitHub: @rashedarman
• Twitter: @rashedarman21
• LinkedIn: Rashed Arman

🔭 Future Features

• Remove a selected book
• Add genre to selected book

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 can give it a star!

Back to top

🙏 Acknowledgments

I would like to Microverse community for helping me to improve my skills.

Back to top

📝 License

This project is MIT licensed.

Back to top