📗 Table of Contents

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

CATALOG OF MY THINGS

The Catalog of my things, a Ruby-built catalog app allows users to efficiently organize, track, and manage their belongings by creating items, categorizing them, preserving and loading data, facilitating organization, and providing a user-friendly interface. Please check this UML class diagram for more details about the project.

🛠 Built With

Tech Stack

Key Features

The key features of this project includes.

• Item Management: It permits users to create, store, and manage a comprehensive list of their belongings
• Categorization and Organization: The app provides a system for categorizing items, allowing users to group and organize their belongings based on different criteria, such as categories custom labels, making it easier to locate specific items.
• Data Preservation and Loading: It offer data backup and retriaval, allowing users to securely store their catalog data in json files.

(back to top)

💻 Video Presentation

• Video link

(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/iankiema/Ruby-capstone-project.git

Install

Go to the project directory:

 cd Ruby-capstone-project

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

 ruby -v

It should display the Ruby version that is currently installed. If this does not happen and only an error notice appears, you should either check your installation or reinstall Ruby.

Download and Install Ruby

Usage

To run the project, execute the following command:

ruby main.rb

Run tests

• To run the tests, run the following command:

    rspec/spec/your_test_file.rb

• To run the linter, run the following command:

    rubocop

Deployment

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

(back to top)

👥 Authors

👤 Ngala Mac

• GitHub: ngalamac
• LinkedIn: Ngala Mac

👤 Ian Kiema

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

👤 Maurice Coker

• GitHub: @coker2019
• Twitter: @Olabisi_coker
• LinkedIn: maurice-coker-174b129b

(back to top)

🔭 Future Features

Here are some future features that could be added to this project.

• User Authentication: This feature will allow users to create accounts and log in to the app, providing a more personalized experience.
• Item Sharing: This feature will allow users to share their items with other users, allowing them to collaborate on cataloging and organization.

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

• Project supervised by Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)