zainab-alzubair/catalog-of-my-things

📗 Table of Contents

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

📖 Catalog of my things

Catalog of my things In this project, we will create a console app that will help you to keep a record of different types of things you own: books, music albums, and games. Everything will be based on the UML class diagram. The data will be stored in JSON files but we will also prepare a database with a tables structure analogical to our program's class structure.

🛠 Built With

Tech Stack

• Ruby.
• SQL.

Key Features

• Add book, music album, and game.
• List books, music albums, games, genres, labels, authors, and sources.

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Download Visual Studio Code.
• Download Git.

Setup

Clone this repository to your desired folder:

• Clone the repo

   git clone https://github.com/odaialazzeh/Catalog-of-my-things.git

Install

• you can run any one of these commands to install bundle on your machine:

- bundle init
- bundle install
- sudo apt bundle install (for Linux)

Usage

• To run the project, execute the following command:

   ruby main.rb

(back to top)

👥 Authors

👤 Odai

• GitHub: odai-alazzeh
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Zainab

• GitHub: Zainab-Al-Zubair
• LinkedIn: LinkedIn

👤 Emmanuel

• GitHub: Emmanuel-Simasiku
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Add more functionality.
• Design beautiful UI.

(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 give it a star.

(back to top)

🙏 Acknowledgments

A list of resources that i find helpful and would like to give credit to :

• Microverse
• GitHub
• Youtube
• W3schools
• Stackoverflow
• Ruby

(back to top)

📝 License

This project is MIT licensed.

(back to top)