MudasirSherwani/Catalog-of-My-Things

📖 Catalog of My Things

📗 Table of Contents

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

📖 Catalog of My Things

This is a console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games. Everything will be based on the UML class diagram presented below. The data will be stored in JSON files but there is also a database with tables structure analogical to the program's class structure.

🛠 Built With

Tech Stack

Ruby , Rspec, Sql, Postgres

Client

• Ruby

Key Features

• [keep a record of different types of things you own]
• [Store the data in JSON files]
• [Add items you own]

(back to top)

(back to top)

demo-video

group demo video for the presentation of the app

Link to demo video

💻 Getting Started

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

Prerequisites

• You need knowledge of basic git commands
• You need knowledge of how to work with kanban board
• You will need a pc and a code editor In order to run this project you need:

Example command: Run

 ruby main.rb

Setup

Clone this repository to your desired folder:

• To run this project, ensure you have basic understanding of ruby
• Install Ruby in your computer

  $ ruby -v
  ruby 3.2.1 (2023-02-08 revision 31819e82c8) [x64-mingw-ucrt]

• clone the project in your computer

  git clone https://github.com/MudasirSherwani/Catalog-of-My-Things.git

Install

Install this project with:

  cd catalog-of-my-things
  gem install robocop
  bundle i
  ruby main.rb

Run tests

To run tests, run the following command:

  rspec spec spec\  

(back to top)

👥 Authors

👤 George Kinyanjui

• GitHub: @george827
• LinkedIn: George Kinyanjui
• twiter: George Kinyanjui

👤 Mudasir Sherwani

• GitHub: @MudasirSherwani
• Twitter: @MudasirSherwani
• LinkedIn: Mudasir Sherwani

👤 SAMUEL KYERE

• GitHub: @admirerbrown
• Twitter: @brown_admirer
• LinkedIn: SAMUEL KYERE

(back to top)

🔭 Future Features

• [IMplement GUI]
• [preserve data]
• [Unit test]

(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 besure to give a star

(back to top)

🙏 Acknowledgments

I would like to thank all code reviewers for making this project better.

(back to top)

📝 License

This project is MIT licensed.

(back to top)