Catalog Of My Things

---

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Catalog_of_my_things]
  • 🛠 Built With
    • Tech Stack
  • Key Features
  • 💻 Getting Started
    • To get a local copy up and running, follow these steps.
    • Prerequisites
    • Setup
  • Install
  • Usage
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 [Catalog_of_my_things]

[Catalog_of_my_things] :- A simple command-line tool that will help you to keep a record of different types of things you own: books, music albums, and games. The data will be stored in JSON files. so you can easily share it with your friends, and access it later.

🛠 Built With

Tech Stack

Client

• Ruby: The primary programming language for the project.

Server

• none

Database

• PostgreSQL

• JSON

Key Features

• Create a catalog :- The user can create a catalog of things they own. The catalog can contain books, music albums, and games.
• Add things to the catalog :- The user can add things to the catalog. Each thing has a title, a author/label/genre, and a year of release.
• List all things in the catalog :- The user can list all things in the catalog.
• Save the catalog to a file :- The catalog data will be saved to a file. The file will be in JSON format.
• Load the catalog from a file :- The catalog data will be loaded from a file. The file will be in JSON format.
• [x]

(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 Computer (MAC or PC)
• Code editor (VSCode,Atom etc...)
• A browser (Chrome,Mozilla,Safari etc...)
• Version Control System (Git and Github)
• Ruby installed: To run a Ruby project, users must have Ruby installed on their system. You can include the minimum required version of Ruby needed to run the project.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/bilalrajput09/Catalog_of_my_things.git

Install

Install this project with:

• Install RubyInstaller Win
• Install Ruby for macOS
• Install Ruby for Linux

Usage

To run this project in the command line, follow these steps:

Open a command prompt or terminal window on your computer.

Navigate to the project directory where you cloned it using the cd command.

Type the following command to run the project:

ruby main.rb

Live Video

Watch the video

👥 Authors

👤 Bilal Ahmed

• GitHub: @bilalrajput09
• Twitter: @bilal_rajput09
• LinkedIn Bilal Rajput

👤 Abdul-Aziz Fakhriddinov

• GitHub: @githubhandle
• Facebook: @facebookhandle
• LinkedIn: LinkedIn

👤 Mohamed Sabry

• GitHub: @mohamedSabry0
• Twitter: @mohsmh0
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Graphical user interface :- The program could be improved by adding a graphical user interface (GUI) to make it more user-friendly and accessible to non-technical users.
• User authentication : Add a feature for user authentication to ensure that only authorized users can access the catalog.
• Integration with external sources :- Integrate the catalog with external sources such as spotify, google books, etc. to make it easier for users to add things to the catalog.
• Search for a thing in the catalog :- The user can search for a thing in the catalog by its title.
• Delete a thing from the catalog :- The user can delete a thing from the catalog.

(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 rate it and give it a star ⭐️...

(back to top)

🙏 Acknowledgments

We would like to thank the Microverse team for allowing us to work on this catalog of my things project.

(back to top)

❓ FAQ

• How do I install and run the project?

  • To install and run the project, you will need to have Ruby installed on your computer. Once you have Ruby installed, you can download the project files and run the program from the command line using the following command:
    ruby main.rb

• What technologies and libraries are used in the project?

  • The project is written in Ruby and does not require any external libraries or dependencies.

• How can I contribute to the project?

  • Contributions to the project are welcome! Please feel free to submit bug reports, feature requests, or pull requests on the project's GitHub repository.

(back to top)

📝 License

This project is MIT licensed.

(back to top)