besufekad-haz/catalog-of-my-things

The "Catalog_of_my_things" is a console app that helps users manage their collections of books, music albums, movies, and games.

Ruby group capstone - Catalog of my things

---

📗 Table of Contents

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

📖 Catalog_of_my_things

[Catalog_of_my_things] :- The "Catalog_of_my_things" is a console app that helps users manage their collections of books, music albums, movies, and games. Data is stored in JSON files and a corresponding database. Users can add, view, and remove items, as well as search for specific items. Have a look at our video presentation of the console app.

🛠 Built With

Tech Stack

Client

• Ruby: The primary programming language for the project.

Server

• none

Database

• PGSQL

Key Features

• Manage collections: Users can track their personal collections of books, music albums, movies, and games using the application.
• Search functionality: The program allows users to search for specific items based on title, artist, or genre.
• Data storage: All data is stored in JSON files, making it easy to import and export collections between devices.
• Database integration: The application includes a database with tables that reflect the class structure of the program, enabling efficient storage and retrieval of data.
• User-friendly interface: The console app provides an intuitive and convenient way for users to manage their collections and keep track of the items they own.

(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 [email protected]:ZewdieMc/catalog-of-my-things.git (SSH)

Install

Install this project with:

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

Usage

To run a Ruby file in the command line, follow these steps:

Open a command prompt or terminal window on your computer.

Navigate to the directory where the Ruby file is stored using the cd command.

Type the following command to run the Ruby file:

ruby main.rb

- where filename.rb is the name of the Ruby file you want to run.

👥 Authors

👤 Zewdie Habtie

• GitHub: ZewdieMc
• Twitter: @HabtieZewdie
• LinkedIn: Zewdie Habtie

👤 Oscar Byiringiro

• GitHub: @githuboscar
• LinkedIn: LinkedIn

👤 Besufekad Alemu

• GitHub: @Besufekad-HAZ
• Twitter: @BesufekadAlemu7
• LinkedIn: @besura

(back to top)

🔭 Future Features

• User authentication :- Implementing a user login system to secure data and allow multiple users to manage their collections separately.
• Online database : Creating an option for users to store their data in an online database, enabling access from any device with an internet connection.
• Barcode scanning :- Adding the capability to scan barcodes on items to automatically populate item details in the collection.
• Integration with external platforms :- Allowing users to import and export data from external platforms such as Deezer, Spotify or other music streaming platforms.

(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 Ruby group capstone - 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 mylist.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)