Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cvalencia1991/ruby-catalog-of-my-things
"Catalog of my things" is a Ruby console app for managing book, music, and game collections. It lets you input and view information about each item, making it an essential tool for collectors.
https://github.com/cvalencia1991/ruby-catalog-of-my-things
rspec ruby
Last synced: about 5 hours ago
JSON representation
"Catalog of my things" is a Ruby console app for managing book, music, and game collections. It lets you input and view information about each item, making it an essential tool for collectors.
- Host: GitHub
- URL: https://github.com/cvalencia1991/ruby-catalog-of-my-things
- Owner: cvalencia1991
- License: mit
- Created: 2023-01-06T19:19:29.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-14T02:16:19.000Z (almost 2 years ago)
- Last Synced: 2023-05-04T16:45:12.288Z (over 1 year ago)
- Topics: rspec, ruby
- Language: Ruby
- Homepage:
- Size: 818 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Catalog of my things ](#-catalog-of-my-things-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)
This project involves creating a console application that allows users to keep track of their personal collection of books, music albums, and games. The program is structured according to the [UML class diagram](./src/images/catalog_of_my_things.png). The data is stored in JSON files and a database is also set up with tables that match the class structure of the program
Server Side
Database
- **List all books**
- **List all music albums**
- **List of games**
- **List all genres (e.g 'Comedy', 'Thriller')**
- **List all labels (e.g. 'Gift', 'New')**
- **List all authors (e.g. 'Stephen King')**
- **Add a book**
- **Add a music album**
- **Add a game**
- **Preserve data in JSON files**
- **Created a console app**
- [Video Presentation](https://drive.google.com/file/d/13-B45_cwSHZzMrKYeY-2BehYVFYm5_Jb/view?usp=sharing)
- If you want to have a glimpse of our project, [here it is](./src//images/console_app.PNG)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
gem install ruby or sudo gem install ruby
gem install rspec
gem install colorize
```
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/cvalencia1991/Ruby-Catalog-of-my-things
```
### Install
Install this project with:
```sh
cd my-project
bundle install
```
### Usage
To run the project, execute the following command:
```sh
ruby main.rb
```
### Run tests
To run tests, run the following command:
```sh
src/spec rspec_file.rb or rspec .
```
### Deployment
You can deploy this project using:
```sh
ruby main.rb
```
👤 **Kanza ahreem**
- GitHub: [@KanzaTahreem](https://github.com/KanzaTahreem)
- Twitter: [@kanza_tahreem](https://twitter.com/kanza_tahreem)
- LinkedIn: [Kanza Tahreem](https://www.linkedin.com/in/kanza-tahreem/)
👤 **Cesar Alberto Valencia Aguilar**
- GitHub: [@cvalencia1991](https://github.com/cvalencia1991)
- Twitter: [@cvalenciaguilar](https://twitter.com/cvalenciaguilar)
- LinkedIn: [@cvalencia1991](https://www.linkedin.com/in/cvalenciaguilar/)
👤 **Shaker AbuDrais**
- GitHub: [@Shaker](https://github.com/shakerAbuDrais/)
- LinkedIn: [Shaker](https://www.linkedin.com/in/shaker-abady/)
- **List all movies**
- **List all sources (e.g. 'From a friend', 'Online shop')**
- **Add a movie**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/cvalencia1991/Ruby-Catalog-of-my-things/issues).
Please ⭐️ this repository if you found the project useful.
I would like to thank for the group project, all great effort get award
> Add at least 2 questions new developers would ask when they decide to use your project.
- **could you deploy this project in any other language?**
- Yes, ou can deploy this project using any other back end language
This project is [MIT](./LICENSE) licensed.