📗 Table of Contents

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

📖 Catalog Of My Things

Catalog Of My Things is a command-line interface (CLI) application designed for users to conveniently manage their collections of books, music albums, movies, and games. This easy-to-use app stores data in JSON files, allowing users to easily add, delete, and update information about their personal belongings all in one place.

🛠 Built With

Tech Stack

• Ruby

• RSpec

• PostgreSQL

Key Features

• conveniently manage your collections of books, music albums, movies, and games.
• Store all your collections in JSON files
• Intuitive command line interface

(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 to install ruby:

 sudo apt install ruby

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Kweeka1/catalog-of-things.git

Install

Install this project with:

  cd catalog-of-things
  bundle install

Usage

To run the project, execute the following command:

  chmod 755 main.rb
  ./main.rb

Run tests

To run tests, run the following command:

  bundle exec rspec spec

👥 Authors

👤 Mohamed Talbi

• GitHub: @kweeka1

👤 Htetaungkyaw

• GitHub: @Htetaungkyaw71

👤 Belal Gamal

• GitHub: @belalgamal46

(back to top)

🔭 Future Features

• Store records in PostgresSQL database
• Add a web interface for better user experience
• Add a backend server to allow remote access

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Put a ⭐️ If you like this project.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for project inspiration.

(back to top)

❓ FAQ

• What version of Ruby does this project work on ?

  • Any version above 2.6

(back to top)

📝 License

This project is MIT licensed.

(back to top)