ZikaZaki/catalog-of-things

This console app project will help users to keep a record of different types of things they own: books, music albums, movies, and games. The data will be stored in JSON files but also a database will be prepared with tables structure analogical to the program's class structure.

Microverse README Template

📗 Table-of-Contents

• 📗 Table-of-Contents
• 📖 Catalog-of-Things
  • UML Diagram
  • 🛠 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-Things

Catalog-of-Things is a Ruby console app which focus on helping users to keep a record of different types of things they own: books, music albums, movies, and games. The data will be stored in JSON files but also a database will be prepared with tables structure analogical to the program's class structure.

UML Diagram

Project UML Diagram

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Languages

• Ruby

Libs

• Colorize
• Pry

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• [Keep-books-records]
• [Keep-albums-records]
• [Keep-movies-records]
• [Keep-games-records]

(back to top)

🚀 Live Demo

Here's the link to the video demo of our project:

• Video Demo Link

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Example command:

 bundle install

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone https://github.com/ZikaZaki/catalog-of-things.git

Install

Install this project with:

Example command:

  cd catalog-of-things
  bundle install

Usage

To run the project, execute the following command:

Example command:

  ruby lib/main.rb

Run tests

To run tests, run the following command:

Example command:

  rspec spec

Deployment

You can deploy this project using:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Zakariya Al-Khamisi (ZikaZaki)

• GitHub: ZikaZaki
• Twitter: Zakariya Al-Khamisi
• LinkedIn: Zakariya Al-Khamisi

👤 Petro Loltolo Lesapiti

• GitHub: @petrolesapiti
• LinkedIn: @petrolesapiti

👤 Sharon Kessio

• GitHub: @kessio
• Twitter: @kessio_sharon
• LinkedIn: sharon-kessio

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [new_feature_1]
• [new_feature_2]
• [new_feature_3]

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

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

(back to top)

❓ FAQ

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

• [Question_1]

  • [Answer_1]

• [Question_2]

  • [Answer_2]

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)