elarhadu/Catalog-of-my-things

In this project, my partners Leehaney ,Yuvenal and I created a console app that helps users to keep a record of different types of things they own: books, music albums, movies, and games. Everything is based on the UML class diagram presented below. The data will be stored in JSON files.

Catalog Of My Things

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors

• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Catalog Of My Things

In this project, my partners Elarh,Yuvenal and I created a console app that helps users to keep a record of different types of things they own: books, music albums, movies, and games. Everything is based on the UML class diagram presented below. The data will be stored in JSON files.

🛠 Built With

Tech Stack

Server

• Ruby

Database

• PostgreSQL

Key Features

• Add a Book
• Add a Game
• Create and manage data about my things
• Add a Music Album
• List all added items
• Keep track of books, music albums, movies, and games and other information

(back to top)

LIVE DEMO

🚀 Demo Video

Please visit our zoom video presentation. Click the Link button.

UML Diagram

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

• To install ruby in your PC. You can read this documentation on how to do so
• Know how to navigate directories or folders at the CLI.
• Know how to get the URL(https/ssh) of a repository on GitHub.
• You should have a code editor installed, preferably VSCode.
• In order to run this project you need:

Setup

In desired folder or directory in the CLI, run the command:

git clone git@github.com:leehaney254/Catalog-of-my-things.git

Navigate into the cloned folder or repository by running the command:

cd Catalog-of-my-things

If VsCode is your default code editor, run:

code .

You are all set up!

Install

Install this project with:

 bundle install

Usage

To run the project, execute the following command:

ruby main.rb

Run tests

To run tests, run the following command:

  rspec spec spec/[filename.rb]

(back to top)

👥 Author

👤 Leehaney George

• GitHub: @leehaney254
• Twitter: @Lee06785586
• LinkedIn: Leehaney George

👤 Emmanuella Adu

• GitHub: @elarhadu
• Twitter: @elarh_
• LinkedIn: Emmanuella Adu

👤 Yuvenal Njoroge

• GitHub: @yuvenalmash
• Twitter: @Juvenal
• LinkedIn: Yuvenal Njoroge

(back to top)

🔭 Future Features

Integration with PostgreSQL

(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 us ⭐

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for this project inspiration.

(back to top)

📝 License

This project is MIT licensed.

(back to top)