/Ruby-Catalog-capstone

A console app that allows users to manage collections of the things they own: books, music albums, movies, and games. The data is stored in JSON files but there is also a database with the structure of tables analogical to the program's class structure.

Primary LanguageRubyMIT LicenseMIT

Ruby Group Capstone Project - Catalog of my things

In this project, we create a console app that helps to keep a record of different types of things you have won: books, music albums, movies, and games. We base our app on a UML class diagram. Data is stored in JSON files and also in a database with tables structure analogical to our program's class structure. Built with RUBY | RSPEC | RUBOCOP | PostgreSQL

Enjoy!

Project Demo Video

Group Project Demo Video

Built With

  • Ruby
  • Terminal
  • IRB
  • Rubocop (linters)
  • TDD via RSPEC

Getting Started

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

Install

In your terminal, navigate to your current directory and run this code

git clone git@github.com:medsonmoombe/Ruby-Catalog-capstone.git ruby-group-capstone

Locate the directory in your file explorer

cd ruby-group-capstone

Install Rubocop

bundle install

Run Linters:

To run rubocop we use:

rubocop

To autocorrect offenses with rubocop we use:

rubocop --auto-correct-all or rubocop -A

Usage

  • Navigate to the file directory ruby-group-capstone in your favorite terminal application
  • Type in the command ruby main.rb to start the Catalog App
  • Read through the list of options presented and type in the number of your desired action

Have fun cataloging your own 'Things' with our Ruby 'Things' Catalog Console App!

Testing

Install the testing library 'rspec' with the following command: gem install rspec

Then within the projects working directory run test using the command rspec in the terminal.

Author1

👤 Emirjeta Veisllari

Author2

👤 Emmanuel Moombe

Author3

👤 Stanley SIMEON

🤝 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

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc

📝 License

This project is MIT licensed.