AbdusSattar-70 / Ruby-Group-Capstone

A Ruby OOP-based solution for managing and organizing your collection of books, games, and music albums. It allows you to add new items, explore your collection by labels, genres, and authors and provides a user-friendly interface for easy navigation. It's a convenient tool to keep track of your inventory of books, games, and music albums.

Ruby-Group-Capstone

---

📗 Table of Contents

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

📖 [Ruby-Group-Capstone]

The Ruby-Group-Capstone project 'The Catalog of My Things' app is a Ruby-based solution for managing and organizing your collection of books, games, and music albums. It allows you to add new items, explore your collection by labels, genres, and authors, and provides a user-friendly interface for easy navigation. It's a convenient tool to keep track of your personal inventory of books, games, and music albums.

🛠 Built With

Tech Stack

Client

• Ruby: The primary programming language for the project.

Server

• none

Database

• Postgresql

Key Features

• Simple command-line interface.
• Support for IRB input formats.
• Add Book, Author, Game, MusicAlbum and Genre
• List all Books, Games, Authors, Music Albums, Genres and Labels.
• Store data in json file.

(back to top)

💻 Video Presentation

• Video link

💻 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 github.com/AbdusSattar-70/Ruby-Group-Capstone

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.

Run tests

rspec spec/filename.rb

👥 Authors

👤 Abdus Sattar

• GitHub: AbdusSattar-70
• Twitter: Abdus Sattar
• LinkedIn: Abdus Sattar

👤 Christian Kiyong

• GitHub: krisbobo
• Twitter: ChrisboboSys
• LinkedIn: kiyong-christian

👤 Okpah Igbo

• GitHub: @david30-maker
• Twitter: @davidigbo1
• LinkedIn: davidigbo/

(back to top)

🔭 Future Features

• Add movie
• Add list all movies feature
• Add remove functionalities for all items

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

• 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)