adel-gu/Catalog-of-my-things

Ruby console app that help you to keep a records of different types of things you own: books, music albums, movies, and games, the data stored in json file.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🎥 Vedio Description
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 📝 License

📖 Catalog of my things

This project is console app built using ruby, the app will help you to keep a record of different types of things you own: books, music albums, movies, and games, the data stored in json file, and it will be always useable whenever you start the app.

🛠 Built With

Tech Stack

• The app built using Ruby.
• The schema file built using SQL.

Key Features

The app help you to keep recods about any items you own, thing like

• Store and Display Movies
• Store and Display Games
• Store and Display Music Albums
• Store and Display Books

(back to top)

Video Description

In this recorder video we are describing how we built this amazing project as a team.

Link to watch the video

(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 should be installed in your local machine
• You need a Terminal.
• You need a code editor eg: VsCode

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone https://github.com/adel-gu/Catalog-of-my-things.git

Install

Install this project with:

Example command:

  cd Catalog-of-my-things
  bundle install

Usage

To run the project, execute the following command:

Example command:

  ruby main.rb

Run tests

To run tests, run the following command:

Example command:

  rspec spec

👥 Authors

👤 Adel Guitoun

• GitHub: @adel-gu
• Twitter: @GuitounAdel
• LinkedIn: adelguitoun

👤 Julius Tetteh

• GitHub: @j-tee
• Twitter: @Julius-Tee
• LinkedIn: julius-tetteh

👤 Kwasi Baayeh

• GitHub: @Baayeh
• LinkedIn: kabaayeh

👤 RICHARD CHILEYA

• GitHub: @RichardChileya
• Twitter: @RichardChileya
• LinkedIn: richard-chileya

(back to top)

🔭 Future Features

• Searching Functionality for a specific item
• Provide a simple way for the user to choose from a list of option such as Source, Label, Author and Genre that the user can select from

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project kindly give it a star.

(back to top)

📝 License

This project is MIT licensed.

(back to top)