/catalog-of-my-things

Catalog-of-my-things is a console app that displays all the owned items of a user, displaying it's authors, labels, sources and genres. It uses json files to store data, allows the user to list "Books, Musics, Movies and Games" and add new items to it's catalog.

Primary LanguageRubyMIT LicenseMIT

Catalog of my things (Ruby group capstone) πŸ“šπŸŽΆπŸŽžοΈπŸ‘Ύ

Catalog-of-my-things is a console app that displays all the owned items of a user. It uses json files to store data, allows the user to list "Books, Musics, Movies and Games" and add new items to it's catalog. The whole project is based on the UML diagram below:

catalog_of_my_things

Built With

  • Ruby (programming language)
  • Linters: Rubocop
  • Visual Studio Code (code editor)
  • RSpec (testings)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • A web browser like Google Chrome.
  • A code editor like Visual Studio Code with Git and Ruby.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Ruby installation.

$ ruby --version && irb

Setup

Clone the repository using the GitHub link provided below.

Install

In the terminal, go to your file directory and run this command.

$ git clone https://github.com/VitorGuedesMadeira/Capstone-Ruby.git
$ cd Capstone-Ruby
$ bundle install
$ code .

Run tests

To install rspec, in the terminal kindly run this command

$ gem install rspec

To run tests, please run this command

$ rspec ./spec/#{filename}_spec.rb

Usage

Kindly modify the files as needed.

Authors

πŸ‘€ Diego Yon πŸ§‘πŸ»β€

πŸ‘€ Vitor Guedes Madeira πŸ§‘πŸ»β€

πŸ‘€ Muhammad Ashraf Siddiqui πŸ§‘πŸ»β€

🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

πŸ“ License

This project is MIT licensed.

UML Diagram

catalog_of_my_things