Daphineatim/catalog-of-my-things

In this project, we are creating a console app that will keep a record of different types of things : books, music albums, movies, and games. Everything will be based on the UML class diagram that was provided as requirements for the project. The data will be stored in JSON files but will also prepare a database with tables structure analogical

📗 Table of Contents

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

📖 Catalog of my things

Catalog of things,in this project, we are creating a console app that will keep a record of different types of things which will help you organize your : books, music albums, movies, and games it will help you preserve the data in JSON format.

CATALOG OF MY THINGS

🛠 Built With Ruby

Tech Stack Ruby

Client

• Ruby

Database

• postgres

Key Features

• 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

(back to top)

🚀 Live Demo

Please visit our zoom video presentation. Click the button .

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

ruby version 2.7.0 or later

Setup

Clone this repository to your desired folder:

  git clone git@github.com:Daphineatim/catalog-of-my-things.git
  cd Catalog-of-my-things

Install

Install this project with:

  bundler install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run tests, run the following command:

  rspec src/spec

Deployment

App not deployed yet

Install

Install this project with:

• No need of installation

Usage

To run the project, execute the following command:

git clone https://github.com/Daphineatim/catalog-of-my-things.git

Run tests

To run tests, run the following command: rspec

Deployment

You can deploy this project using:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Hope Daphine Atim

• GitHub: @daphineatim
• Twitter: @DhaPhyn
• LinkedIn: Daphine atim

👤 Vitalis Mutwiri

• GitHub: @svitalis123
• Twitter: @WilsonVitalis
• LinkedIn: vitalismutwiri

👤 Orji Maxwell

• GitHub: @githubhandle
• LinkedIn: LinkedIn
• Twitter: Twitter

(back to top)

🔭 Future Features

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

• [Ability to deploy on the web]
• Add Games and Author Feature
• Movies Feature
• Genere Feature

(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

Give credit to everyone who inspired your codebase.

I would like to thank...

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