/catalogue-of-my-things

A console app that will help us to keep a record of different types of things we own: books, music albums, movies, and games.

Primary LanguageRubyMIT LicenseMIT

catalogue-of-my-things

A console app that will help us to keep a record of different types of things we own: books, music albums, movies, and games.

📗 Table of Contents

Built With

Tech Stack

Client
  • Ruby
  • Key Features

    1. Inventory Management
  • Manage books, music albums, movies, and games.
  • Options to list, add, and organize items.
  • 2. Intuitive Console Interface
  • User-friendly menu-driven system.
  • Seamless interaction and navigation.
  • 3. Persistent Data Storage
  • Save item details using JSON files.
  • Preserves collections between sessions.
  • 4. Relational Database Support
  • Schema.sql for relational database structure.
  • (back to top)

    Live Demo

    Explore the live demo through our video presentation.

    (back to top)

    Getting Started

    Prerequisites

    Before you begin, ensure you have Ruby 3.2.2 release installed

    Setup

    1. Clone this repository to your local environment:

      git clone https://github.com/rmiyoyo/catalogue-of-my-things.git
    2. Navigate to the project directory:

      cd catalogue-of-my-things

    Install

    • Run bundle install to install required gems

    Usage

    • Run the script with ruby main.rb and explore the Catalogue Of My Thing application.

    (back to top)

    Authors

    This project was crafted by a dedicated team:

    Richard Sikaonga

    Nelly Telli

    Raphael Miyoyo

    (back to top)

    Future Features

    1. Edit and Remove Options
  • Modify details of existing items.
  • Remove unwanted items from the inventory.
  • 2. Advanced Sorting and Filtering
  • Sort and filter items based on various criteria.
  • Enhance organization and accessibility.
  • 3. Data Export and Import
  • Allow users to export and import their data.
  • Facilitate data backup and migration.
  • 4. Recent Messages Database
  • Store recent messages for reference
  • Access a log of recent interactions.
  • (back to top)

    Contributing

    We welcome contributions to improve this project. If you'd like to contribute, please open an issue or create a new fork.

    (back to top)

    Show your support

    Star this repository if you find it useful!

    (back to top)

    Acknowledgments

    Special thanks to Microverse for making this project possible.

    (back to top)

    📝 License

    This project is licensed under the MIT License.

    (back to top)