https://github.com/praisespjmt/personal-catalog
This project implemented a console app that will help you to keep a record of different types of things you own: books, music albums, and games. The data are stored in JSON files. The project was implemented using Ruby and SQL
https://github.com/praisespjmt/personal-catalog
ruby sql
Last synced: about 1 year ago
JSON representation
This project implemented a console app that will help you to keep a record of different types of things you own: books, music albums, and games. The data are stored in JSON files. The project was implemented using Ruby and SQL
- Host: GitHub
- URL: https://github.com/praisespjmt/personal-catalog
- Owner: PraisesPJMT
- License: mit
- Created: 2022-11-21T08:12:08.000Z (over 3 years ago)
- Default Branch: development
- Last Pushed: 2022-11-25T21:58:20.000Z (over 3 years ago)
- Last Synced: 2025-02-04T12:56:33.979Z (about 1 year ago)
- Topics: ruby, sql
- Language: Ruby
- Homepage:
- Size: 52.7 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
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)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
> This project implemented a console app that will help you to keep a
> record of different types of things you own: books, music albums, and games.
> Everything was based on the [UML class diagram](https://github.com/microverseinc/curriculum-ruby/blob/main/group-capstone/images/catalog_of_my_things.png).
> The data are stored in JSON files. A database was also prepared with
> tables structure analogical to the console app program's class structure.
> Here are the tech stacks applied in this project.
Languages
Linter
Test Library
Database
### Key Features
> This console app has the following feature abilities:
- Add various items of choice
- Add a book
- Add a music album
- Add a game
- View various items in personal collection
- 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')
### Prerequisites
In order to run this project you need:
- Install Ruby on your computer (machine)
### Setup
Clone this repository to your desired folder:
```sh
git clone git@github.com:PraisesPJMT/Personal-Catalog.git
cd Personal-Catalog
```
### Install
Install this project with:
```sh
gem install bundler
bundle install
```
### Usage
To run the project, execute the following command:
```sh
ruby main.rb
```
### Run tests
In order to run unit tests on the local machine Rspec gem should be installed
- run in the terminal
```sh
gem install rspec
```
- After installation run
```sh
rspec spec/file_name.rb
```
- If you are interested in running all the tests together then
```sh
rspec spec
```
- For more information please visit [RubyGuides](https://www.rubyguides.com/2018/07/rspec-tutorial/).
## 👥 Authors
👤 **Benard Pacho** (Kenya)
[](https://github.com/benardop/)
[](https://www.linkedin.com/in/ochieng-benard-8264b815/)
[](https://twitter.com/Bepacho)
👤 **Shaquille Ndunda** (Kenya)
[](https://github.com/shaqdeff)
[](https://www.linkedin.com/in/shaquille-ndunda-b13a95107/)
[](https://twitter.com/shaquillendunda)
👤 **Praises Tula** (Nigeria)
[](https://github.com/PraisesPJMT/)
[](https://www.linkedin.com/in/praises-tula/)
[](https://twitter.com/PraisesPJMT/)
[](mailto:praisesmusa@gmail.com)
[](https://angel.co/u/praises-tula/)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project!