Catalog of my things

📗 Table of Contents

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

📖 Catalog of my things

Catalog of my things is a comprehensive project designed to help users organize and manage their personal catalog of items, including books, games, and music. Users can add items with details such as publishers, cover states, and authors for books and games. They can also create labels with customizable titles and colors to categorize their collection. The project utilizes JSON file storage for data consistency and offers functionalities like listing items, archiving, and ensuring file existence. With its user-friendly interface, "My Catalogue of Things" empowers users to effectively organize and streamline their collection of books, games, and music, while maintaining an organized catalog.

🛠 Built With

Tech Stack

Ruby

• Ruby

Key Features

• [accepts data from the user to create an album]
• [save the data to a file when the user exits the program]
• [accepts data from the user to create a book]
• [User can also create labels related to a book and the user can list the books and the labels and view them]
• [User can also add multiple games and their authors and can list them when needed]
• [saves the user input data to a file automatically after all inputs are verified by the program]
• [retrieve data from the file when the program starts]

(back to top)

Video Presentation

Watch video

💻 Getting Started

To get started with this project and have a local copy and running, follow these steps:

Prerequisites

In order to run this project you need:

A Computer
Code editor (VSCode,Atom etc...)
Version Control System (Git and Github)
NodeJS (https://nodejs.org/en/)
Ruby (https://www.ruby-lang.org/en/downloads/)

Setup

Clone this repository to your desired folder: Example commands:

  cd my-folder
  git clone https://github.com/alexiscyber14/RUBY_CAPSTONE_PROJECT.git

Install

Install this project with:

• install Ruby on your computer
• install RSPEC TEST FRAMEWORK

Usage

• To use this project content, you need to have ruby installed on you computer and must have prior knowledge in basic programming

Run tests

To run tests:

gem intall rspec
rspec spec

Authors

👤 Alexander Ssenyondo

• GitHub: @alexiscyber14
• Instagram:@Alexiscyber14
• LinkedIn:@Alex_Ssenyoondo
• wellfound:@alexiscyber14

👤 Belden Mugauri

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Fuad Abdlemoin

• GitHub: @fuadmoin
• Twitter: @Fuad01804580
• LinkedIn: Fuad Moin

(back to top)

🔭 Future Features

Here are some potential future features that can be added to enhance the functionality of the classes:

• [] Addition of more tests: Will expand the project classes to demostrate more of the design process.
• [] Add an artist class for the music album
• [] Add add a class of favorites on the music, book, and games so that user can have a list of their favorites
• [] Link it with a website

(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 ⭐️.

(back to top)

🙏 Acknowledgments

I would like to thank MICROVERSE for their contribution to the material used in this project.

License

This project is MIT licensed