README.md

CatalogMyThings

📗 Table of Contents

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

📚 CatalogMyThings 🎵🎮

CatalogMyThings is a Ruby-based cataloging application that helps you organize your collection of books, music albums, and games. 📖🎶🎮 It allows you to create, manage, and categorize items using labels and genres. 🏷️📚🎶 With an intuitive command-line interface, you can easily add, list, and archive items in your collection. 📁✨

🛠 Built With

Tech Stack

Ruby

• Ruby

IDE

• Visual Studio Code

Key Features

• Add and manage books, music albums, and games.
• Assign labels and genres to categorize your items.
• Archive items based on publish date or condition.
• User-friendly command-line interface for easy navigation.
• Data persistence using JSON files.
• Simple and efficient organization of your personal catalog.
• Gemfile
• Rubocop
• Gemfile.lock
• Unit Testing
• license

(back to top)

🚀 Live Demo

• Video Walkthrough

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

install ruby

Setup

Clone this repository to your desired folder:

cd my-folder git clone git@github.com:AnsarIbrahim/My_Things-Ruby-Capstone.git

Install

Install this project with:

  cd my-project
  gem install

Usage

To run the project, execute the following command:

• Clone the repository.
• Run ruby main.rb to start the application.
• Use the menu to add, list, and archive items.
• Enjoy effortless cataloging and organization!

Run tests

To run tests, run the following command:

  RSpec

Deployment

You can deploy this project using in Local Machine:

  ruby main.rb

(back to top)

👥 Authors

👤 Ansar Ibrahim

• GitHub
• LinkedIn
• Twitter

👤 Md. Porag Sarkar

• GitHub: @porag-m06
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Create Movie
• Create Source
• List all movies
• List all sources (e.g. 'From a friend', 'Online shop')
• Add a movie
• Deployment

(back to top)

🤝 Contributing

• Contributions, issues, and feature requests are welcome!
• Feel free to open issues or pull requests for bug fixes or enhancements.
• Follow the code of conduct and contribution guidelines.

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give it a ⭐️

(back to top)

🙏 Acknowledgments

• Microverse and my coding partner Md. Porag Sarkar 💖💖

(back to top)

📝 License

This project is MIT licensed.

(back to top)