Skip to content

"Catalog of my things" is a simple console app that allows users to manage collections of the things they own.

License

Notifications You must be signed in to change notification settings

zhorabay/Catalog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

77 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ruby group capstone - Catalog of my things

📗 Table of Contents

📖 Ruby Catalog

[Ruby Catalog] is a Ruby project that implements OOP principles like: abstraction, inhertance, polymorphism and encapsulation. It is a catalog of my things, where I can add, remove, update and view my things. It is a command line application that runs in IRB.

🛠 Built With

Tech Stack

Client
  • Ruby
  • Key Features

    • 🔰 [ Add new book ]
    • 🔰 [ Add new games ]
    • 🔰 [ Add new music albums ]
    • 🔰 [ List all items added ]

    (back to top)

    🚀 Live Demo

    (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 in your machine. you can download it from here
    • ✔ IDE or a code editor installed in your machine.
    • ✔ IRB.
    • Git installed in your machine.
    • ✔ Sign in or sign up to your Github account.
    • ✔ A professional editer such as VS Code.
    • ✔ An Updated web browser such as Google Chrome, you can download it from here.
        ruby
        bundler
    

    Setup

    Clone this repository to your desired folder:

      git clone https://github.com/zhorabay/Catalog.git

    Usage

    • To run the project, execute the following command:
     Clone this repository to your desired folder:
    
     Choose a directory
     Open a Terminal
     write: git clone git@github.com:zhorabay/Catalog.git
     get into to directory "Catalog"
     write: npm install

    Install

    Install this project with:

      cd Ruby_Catalog
      bundle install

    It will install the required gemfile for running the project

    (back to top)

    👥 Author

    👤 Garvin Chimone

    👤 Jubaer Maruf

    👤 Assem Zhorabay

    (back to top)

    🔭 Future Features

    • [ Link to the database ]
    • [ List movies ]
    • [ Add Movies ]
    • [ Add TV Shows ]
    • [ List TV Shows ]

    (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, kindly drop a star ⭐️ for the repository;

    (back to top)

    🙏 Acknowledgments

    • We would like to express our heartfelt gratitude to Microvere for the invaluable learning experience they have provided.

    (back to top)

    📝 License

    This project is MIT licensed.

    (back to top)

    About

    "Catalog of my things" is a simple console app that allows users to manage collections of the things they own.

    Topics

    Resources

    License

    Stars

    Watchers

    Forks

    Releases

    No releases published

    Packages

    No packages published

    Languages