README.md

Catalog of my things

📗 Table of Contents

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

📖 Catalog of my things

Catalog of my things is a project that will implement a console app that will help keep a record of different types of things you own: books, music albums, movies, and games.The data will be stored in JSON files but will also prepare a database with tables structure analogical to the program's class structure.

🛠 Built With

Tech Stack

• Ruby

Key Features

• Present the user with a list of options to perform and to choose a option.
• List all books
  • List all music albums
  • List all movies
  • List of games
  • List all genres (e.g 'Comedy', 'Thriller')
  • List all labels (e.g. 'Gift', 'New')
  • List all authors (e.g. 'Stephen King')
  • List all sources (e.g. 'From a friend', 'Online shop')
  • Add a book
  • Add a music album
  • Add a movie
  • Add a game
• All data should be preserved by saving collections in .json files.
• Add unit test for all implemented methods
• All data preserved by saving collections in .json files.
• Quit the app.

(back to top)

🚀 Live Demo

• [Live Demo Link](Comming Soon!)

(back to top)

🎥 Live Presentation

• Presentation

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

-VScode -Installed Ruby

Setup

Clone this repository to your desired folder:

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

Install

Install this project with:

  bundle install

Usage

To run the project, execute the following command in your terminal:

ruby main.rb

Run tests

To run tests, run the following command:

  rspec ./spec

(back to top)

👥 Authors

👤 Fombi Favour

• GitHub: Fombi-Favour
• Twitter: @FavourFombi
• LinkedIn: Fombi Favour

👤 George Hamman

• GitHub: @githubhandle
• LinkedIn: George Hamman

👤 Karan Joshi

• GitHub: @githubhandle

• Twitter: @twitterhandle

• Linkdin: @linkdinhandle

  👤 Austin Obimbo

• GitHub: GitHub

• WellFound: WellFound

• LinkedIn: Linkedin

(back to top)

🔭 Future Features

• Comming soon

(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 you can share this project to your friend

(back to top)

🙏 Acknowledgments

I would like to thank microverse for this project

(back to top)

📝 License

This project is licensed under the MIT License.

(back to top)