Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

"Catalog of My things" is a program made in ruby ​that allows you to manage through the command line the status of your Books, Music Albums and Games.
https://github.com/nitbravoa92/catalog-of-my-things

object-oriented-programming rspec rubocop ruby solid-principles

Last synced: 21 days ago
JSON representation

"Catalog of My things" is a program made in ruby ​that allows you to manage through the command line the status of your Books, Music Albums and Games.

Awesome Lists containing this project

README 

        





  
Catalog Of My Things | Ruby Project





# 📗 Table of Contents



- [📗 Table of Contents](#-table-of-contents)

- [OOP Catalog Of My Things ](#-oop-catalog-of-my-things-)

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

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

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

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

    - [Run tests](#run-tests)

  - [👥 Authors ](#-authors-)

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

  - [🤝 Contributing ](#-contributing-)

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

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)



---



# Catalog of My Things 



**"Catalog of My things"** is a program made in ruby ​that allows you to manage through the command line the status of your Books, Music Albums and Games. You will be able to saved them, list them and define if it time to archive them upon their antiquity.



[Find a video link of this project here:] (https://drive.google.com/file/d/19yOqle71XGMpCnwxi3YuiQUZhSILR7H8/view?usp=sharing) 



---



## 🛠 Built With 



### Tech Stack 



  Ruby

  



---



### Key Features 



-**[Use of UML diagram as base]**

-**[Work on Pair Programming]**

-**[Use Gitflow]**

-**[Implement OOP principles and follow best practicies]**

-**[Use of Inheritances, Modules, Association]**

-**[generate a UI with the Console as Entry Point]**

-**[Generate a schema.sql file with tables in structure]**

-**[Generate Tests ]**



    

      
  • Ruby
    • 

      
  • Linters

        
      

            
    • Rubocop
      • 

          
    

      
    • 

      
  • Apply SOLID principles
    • 

      
  • Data persistent in JSON files
    • 

      
  • Follow Microverse's list of best practices
    • 




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



    

        
  • A code editor (we recommend Visual Studio Code)
    • 




    

        
  • Git and a GitHub account
    • 




### Setup



Clone this repository to your desired folder by using this 👇️ command :



```

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

```



### Install



Go to the project directory:



```

 cd catalog-of-my-things

```



Before to run the program, verify that you have Ruby installed on your OS running the following command:



```

 ruby -v

```



It should show you the version of ruby ​​installed. If this does not happen and only an error message is displayed, then you should either verify your installation or install Ruby from scratch.



[Download and Install Ruby](https://www.ruby-lang.org/en/downloads/)



### Usage



Run the following command inside the project folder:



```

 ruby main.rb

```



This will display the main application menu:



```

Welcome to your Catalog Manager!



1'List all books'

2'List all music albums'

3'List all games'

4'List all genres'

5'List all Labels'

6'List all authors'

7'Add a book'

8'Add a music album'

9'Add a game'

```



You can navigate through the program's options menu to add books, music albums and games. You can also see the list of all the records you have previously added, and see also genres, labels and authors independently.



### Run tests



- In the Command Line:

```

 rspec spec

   or

 rspect -file-name-

```



(back to top)



---



## 👥 Authors 



👤 **Nitcelis Bravo**



- GitHub: [Nitcelis Bravo](https://github.com/NitBravoA92)

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

- LinkedIn: [Nitcelis Bravo Alcala](https://www.linkedin.com/in/nitcelis-bravo-alcala-b65340158)



👤 **Andy Zam**



- GitHub: [Andres Zamorano](https://github.com/Dachrono)

- Twitter: [Andres Zamorano](https://twitter.com/Dachrono)

- LinkedIn: [Andres Zamorano](https://www.linkedin.com/in/andres-zamorano-785b77a1/)



👤 **Hernán Güemes**



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

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

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/hernanguemes/)



(back to top)



---



## 🔭 Future Features 



Upcoming improvements:



- [ ] **Include Delete options**

- [ ] **Add Movies class**



(back to top)



---



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](https://github.com/NitBravoA92/catalog-of-my-things/issues).



(back to top)



---



## ⭐️ Show your support 



If you like this project and know someone who might find it helpful, please share it.

Or give it a **star** ⭐️ if you like this project!



(back to top)



---



## 🙏 Acknowledgments 



I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.



(back to top)



---



## 📝 License 



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



(back to top)



---