/catalog-of-my-things-capstone

My Ruby capstone project

Primary LanguageRubyMIT LicenseMIT

πŸ“— Table of Contents

Catalog of My Things

Catalog of My Things is a software application that allows users to keep track of their personal belongings. It can be used to catalog any type of item, such as books, movies, music, games, tools, electronics, and more. Users can add items to their catalog by entering information such as the item's name, description, purchase date, and price. They can also add photos of their items.

Once an item is added to the catalog, users can view and edit its details, as well as track its status (e.g., borrowed, lent, lost). Users can also generate reports to see a list of all their items, or to filter items by category, date, or other criteria.

πŸ›  Built With

Tech Stack

Ruby

Key Features

The key features of this project includes.

  • Ability to catalog any type of item
  • Ability to add photos of items
  • Ability to view and edit item details
  • Ability to track item status
  • Ability to generate reports

(back to top)

πŸš€ Live Demo

The Live Demo of this Capstone Project is available now on YouTube.

(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:

  • A code editor (Visual Studio Code is recommended)

  • Git and a GitHub account

Setup

Clone this repository to your desired folder by using this πŸ‘‡οΈ command :

git clone https://github.com/jecode93/catalog-of-my-things-capstone.git

Install

Go to the project directory:

cd catalog-of-my-things-capstone

Before to run the program, verify that you have Ruby installed on your OS running the following command:

 ruby -v

It should show you the version of Ruby ​​installed. If this does not happen and only an error message is displayed, then you should either verify your installation or install Ruby from scratch.

Download and Install Ruby

Usage

To run the project, execute the following command:

ruby main.rb

Run tests

rspec

Deployment

  • Deployment is not applicable in this project at the moment.

(back to top)

πŸ‘₯ Authors

πŸ‘€ Jean Emmanuel Cadet

πŸ‘€ Mohamed Aden Ighe

πŸ‘€ Nwanjoh Nalian Achei

(back to top)

πŸ”­ Future Features

Here are some future features that could be added to the Catalog of My Things in the future.

  • Artificial intelligence (AI) powered features: AI could be used to help users automatically identify and catalog items, as well as to provide recommendations for new items to add to their collection.

  • Integration with smart home devices: The Catalog of My Things could be integrated with smart home devices, such as smart speakers and displays, to allow users to control their catalog using voice commands.

  • Augmented reality (AR) and virtual reality (VR) features: AR and VR could be used to create a more immersive experience for users, allowing them to view their catalog items in 3D or to even "walk through" their collection.

  • Social media integration: Users could be able to share their catalogs with others on social media, or to see what other people are collecting. Marketplace integration: Users could be able to buy and sell items from their catalogs through a marketplace integration.

These are just a few ideas for future features that could be added to the Catalog of My Things project. The specific features that are added will depend on the needs and wants of the users.

(back to top)

🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a star⭐️ or a thumbs up πŸ‘ if you like this project! You can visit my GitHub profile for more of my projects.

(back to top)

πŸ™ Acknowledgments

(back to top)

πŸ“ License

This project is MIT licensed.

(back to top)