Cluab / catalog-of-things

this is a console app that allows users to keep a record of different types of things they own, such as books, music albums, movies, and games. It is based on a UML class diagram and stores data in JSON files and a database with tables structure analogical to the program class structure.

Microverse README Template

📖 [catalog of my things]

[Catalog of My Things] is a console app that allows users to keep a record of different types of things they own, such as books, music albums, movies, and games. It is based on a UML class diagram and stores data in JSON files and a database with tables structure analogical to the program class structure.

🛠 Built With

Tech Stack

A brief description on the project

Video description

Database

• Ruby
• PostgreSQL

Key Features

• [Stores data in json file]
• [Add several types of items]
• [show the list of items stored in it]

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

Ruby installed on your machine

Setup

Clone this repository to your desired folder:

clone repo to your desired folder:

git clone [e-mail]:heintayzar-hm/catalog-of-things.git

Install

Install this project with:

  cd catalog-of-things

  bundle install

Usage

To run the project, execute the following command:

 ruby main.rb

Run tests

To run tests, run the following command:

  rspec

(back to top)

👥 Authors

👤 Ibrahim Suhail Al-Yousefi

• GitHub: @cluab
• Twitter: @cluab122
• LinkedIn: Ebrahim Al-Yousefi
• Instagram: @27.i.b

👤 Andrea Tamara Diegaardt

• GitHub: @TechnoAndy
• Twitter: ADiegaardt
• LinkedIn: LinkedIn

👤 Hein Tay Zar

• GitHub: @Hein Tay
• Twitter: @Hein Tay
• LinkedIn: Hein Tay

(back to top)

🔭 Future Features

• [Delete items]
• [Add movies class]
• [Add source class]

(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 give it a star.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse and my teammates for the idea of this project.

(back to top)

❓ FAQ (OPTIONAL)

• What type of Structured Query Language did we use for the database schema?

  • We used PostgreSQL for the database schema. The schema is defined in the schema.sql file.

• Where are the application features linked for display on the user interface?

  • The application features are linked and implemented in the main.rb file. The main.rb file serves as the entry point for the console application and allows users to manage collections of the things they own. The console app presents a list of options to perform, allows users to choose an option, and prompts them for any necessary parameters. The user interface also makes use of the data stored in the database and JSON files to display information about the user's collections.

(back to top)

📝 License

This project is MIT licensed.

(back to top)