tonnytech/catalog-of-things

Catalog of my things.

📗 Table of Contents

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

Description

In the Catalog of my possessions project, we developed a console application designed to assist users in maintaining a comprehensive inventory of their belongings, including books, music albums, movies, and games. This application's foundation is rooted in the UML class diagram depicted below. All data is stored in JSON files, but in addition, we've prepared a database with tables structured similarly to the classes in the program.

🛠 Built With

Tech Stack

• Interactive Ruby

Video presentation

Click here to see our presenation

Key Features

Key features of the application

• Set up associations as per UML diagram
• Add basic UI
• Preserve data into JSON
• Unit tests
• Prepared Schema for tables structure.

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

• Interactive Ruby.
• Code Editor.

Setup

Clone this repository to your desired folder:

  cd my-folder
<<<<<<< HEAD
  git clone [email protected]:yusufobr/catalog-of-things.git
=======
  gh repo clone ` [email protected]:yusufobr/catalog-of-things.git`
>>>>>>> 9ddfc7051c4d0397df092451139f31a5432df8f6

Installation

Install Ruby Installer using this link

• Ruby Installer.

(back to top)

Usage

To run the project, execute the following command:

ruby main.rb

To run the project, execute the following command:

rspec spec --format documentation

or

rspec spec

👥 Authors:

👤 Tonny Tei

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

👤 Youssef Oubari

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

👤 Munana Clinton

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

(back to top)

🔭 Future Features

• Stay tuned to have more exciting features.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the Issues.

⭐️ Show your support

If you like this project, show your support by giving the project a star ⭐️, thanks in advance.

🙏 Acknowledgments

I would like to thank Microverse for including this in their curriculum.

📝 License

This project is MIT licensed.

(back to top)