https://github.com/devmunyi/catalog-of-my-things
https://github.com/devmunyi/catalog-of-my-things
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/devmunyi/catalog-of-my-things
- Owner: devMunyi
- License: mit
- Created: 2023-01-09T08:50:54.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-02T18:38:34.000Z (over 3 years ago)
- Last Synced: 2025-03-04T01:41:27.662Z (over 1 year ago)
- Language: Ruby
- Size: 645 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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)
- [💻 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](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
> In this project, we created a console app that will help you to keep a record of different types of things you own: books, music albums, and games. Everything will be based on the UML class diagram presented below. The data will be stored in JSON files.
[Project Presentation Video](https://drive.google.com/file/d/1yFpV2ZW-K-gqCwvZ5U8RDJLw1W-wodfO/view?usp=share_link)
## UML Diagram
**You can do the following with app:**
- List all books
- List all music albums
- List all movies
- List of games
- List all genres
- List all labels
- List all authors
- List all sources
- Add a book
- Add a music album
- Add a movie
- Add a game
- Persist the data in a json file.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).
### Setup
Clone this repository to your desired folder or download the Zip folder:
```
git clone https://github.com/devMunyi/catalog-of-my-things.git
```
- Navigate to the location of the folder in your machine:
**`you@your-Pc-name:~$ cd catalog-of-my-things`**
### Install
To install all dependencies, run:
```
bundle install
```
### Usage
To run the project, follow these instructions:
- After Cloning this repo to your local machine.
- To get it running on your machine, you may open the project on your IDE and open the terminal
- On the terminal you can run:
```
ruby main.rb
```
- After, you can follow along the app and run the appropriate option from list to interact with it.
### Run tests
To run tests, run the following command:
```
rubocop
```
👤 **Samuel Munyi**
- GitHub: [devMunyi](https://github.com/devMunyi)
- LinkedIn: [Samuel Munyi](https://www.linkedin.com/in/samuel-munyi)
- Twitter: [munyi_sam](https://twitter.com/munyi_sam)
👤 **Zuhaib Amjad**
- GitHub: [Zuhaib042](https://github.com/Zuhaib042)
- Twitter: [Zuhaib042](https://twitter.com/Zuhaib042)
- LinkedIn: [zuhaib-amjad](https://www.linkedin.com/in/zuhaib-amjad)
👤 **Kene Agagwu**
- GitHub: [kene-creator](https://github.com/kene-creator)
- LinkedIn: [kenechukwuagagwu](https://linkedin.com/in/kenechukwuagagwu)
- [ ] **Implement more methods.**
- [ ] **Write Extra Message.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project and how I managed to build it!
- The original design ideal from Microverse💕.
- Project from [Microverse](https://bit.ly/MicroverseTN) Ruby / Database and Interviewing module.
- Thanks to the Microverse team for the great curriculum.
- Thanks to the Code Reviewer(s) for the insightful feedbacks.
- A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
- Hat tip to anyone whose code was used.
- **Can I fork and reuse the repository**
- Yes please, feel free.
- **Can I improve the repository, and my changes will be accepted if they are good?**
- Yes please, nice ideas are welcome, please.
This project is [MIT](./LICENSE) licensed.