Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yasinabdmahmood/catalog-of-my-things


https://github.com/yasinabdmahmood/catalog-of-my-things

Last synced: 13 days ago
JSON representation

Awesome Lists containing this project

README 

        
## 📗 Table of Contents



- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

    - [Video Presentation](#video-presentation)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Install](#install)

  - [Usage](#usage)

  - [Run rspec test](#run-rspec)

  - [Run rubocop linters test](#run-rubocop)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)



# 📖 Catalog Of My Things 



> Catalog of my things 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 is be based on the UML class diagram presented below. The data is stored in JSON files but you there is also  a database with tables structure analogical to the  program's class structure.



**Catalog of my things** is a command line based desktop application.



## 🛠 Built With 



### Tech Stack 



> Ruby



Database

  



### Key Features 



> Key Features:



- **Add Items : Book, Game and Music Album**

- **Preserve data in JSON file format**

- **Tabular Data Visualization**



### Video presentation  

- [Click here](https://drive.google.com/file/d/11UhU_JYFRqlpS1Ofg2o7xudzUA1rTLL1/view?usp=sharing

)



(back to top)



## 💻 Getting Started 



> First of all user should have Ruby installed on their machine or system then just follow these steps.



### Prerequisites 



In order to run application please proceed with following steps :



### Setup 



Clone this repository to your desired folder:



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



### Install 



Install this project with:



run `bundle install` and hit enter.



### Usage 



To run the project, execute the following command:



run `ruby main.rb` and hit enter.



### Run rspec tests 



To run tests, run the following command:



run `rspec spec` and hit enter.



### Run rubocop linters test 



To run tests, run the following command:



run `rubocop` and hit enter.



For auto-correction use below command 



run `rubocop -a` and hit enter.



## 👥 Authors 

👤 **Aakash Verma**



- GitHub: [@skyv26](https://github.com/skyv26)

- Twitter: [@vrma_aakash](https://twitter.com/vrma_aakash)

- LinkedIn: [dev.aakashv](https://linkedin.com/in/skyv2022)



👤 **Yaseen Abd Alwahid**



- GitHub: [@yasinabdmahmood](https://github.com/yasinabdmahmood)

- LinkedIn: [yaseen Abd alwahid](https://www.linkedin.com/in/yaseen-abdalwahid/)



👤 **Juan Diaz**



- GitHub: [@juanmanuelbyc](https://github.com/juanmanuelbyc)

- LinkedIn: [juandiaz](www.linkedin.com/in/juandiaz1991)



(back to top)



## 🔭 Future Features 



> We will soon introduce following features.



- [ ] **Application Security**

- [ ] **Application Data Encryption**

- [ ] **Improve data visualization**



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](../../issues/).



(back to top)



## ⭐️ Show your support 



> Write a message to encourage readers to support your project



If you like this project please give a star to this repo and follow us on above mentioned social handles.



(back to top)



## 🙏 Acknowledgments 



> Give credit to everyone who inspired your codebase.



- Microverse



(back to top)



## 📝 License 



This project is [MIT](./MIT.md) licensed.



(back to top)