README.md

📗 Table of Contents

• 📗 Table of Contents
• 📖 Catalog of my things
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Catalog of my things

This project involves creating a console application that allows users to keep track of their personal collection of books, music albums, and games. The program is structured according to the UML class diagram. The data is stored in JSON files and a database is also set up with tables that match the class structure of the program

🛠 Built With

Tech Stack

Server Side

• Ruby
• Json

Database

• PostgreSQL

Key Features

• List all books
• List all music albums
• List of games
• List all genres (e.g 'Comedy', 'Thriller')
• List all labels (e.g. 'Gift', 'New')
• List all authors (e.g. 'Stephen King')
• Add a book
• Add a music album
• Add a game
• Preserve data in JSON files
• Created a console app

(back to top)

🚀 Live Demo

• Video Presentation
• If you want to have a glimpse of our project, here it is

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

 gem install ruby or sudo gem install ruby
 gem install rspec
 gem install colorize

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/cvalencia1991/Ruby-Catalog-of-my-things

Install

Install this project with:

  cd my-project
  bundle install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run tests, run the following command:

  src/spec rspec_file.rb or rspec .

Deployment

You can deploy this project using:

  ruby main.rb

(back to top)

👥 Authors

👤 Kanza ahreem

• GitHub: @KanzaTahreem
• Twitter: @kanza_tahreem
• LinkedIn: Kanza Tahreem

👤 Cesar Alberto Valencia Aguilar

• GitHub: @cvalencia1991
• Twitter: @cvalenciaguilar
• LinkedIn: @cvalencia1991

👤 Shaker AbuDrais

• GitHub: @Shaker
• LinkedIn: Shaker

(back to top)

🔭 Future Features

• List all movies
• List all sources (e.g. 'From a friend', 'Online shop')
• Add a movie

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Please ⭐️ this repository if you found the project useful.

(back to top)

🙏 Acknowledgments

I would like to thank for the group project, all great effort get award

(back to top)

❓ FAQ

Add at least 2 questions new developers would ask when they decide to use your project.

• could you deploy this project in any other language?

  • Yes, ou can deploy this project using any other back end language

(back to top)

📝 License

This project is MIT licensed.

(back to top)