/catalog

Primary LanguageRuby

Microverse

Ruby Shell Script

Catalog πŸ’Ώ πŸ“š πŸ“

This repo holds a command line interface app built with Ruby that will help users to keep a record of different types of things, like books, music albums, and games. The app is based on the UML class diagram provided in the README and includes a database schema analogical to the class structuture of the app.

Built With πŸ› οΈ

  • Ruby: Popular programming language that’s used for lots of things, from web app development to data analysis.
  • GitHub flow: Correct use of Branches for deployment and features development.
  • Linters Check (Rubocop): Local and Pull Request check for errors, bugs and stylistic errors in code.
  • RSpec: Unit test framework for the Ruby programming language.
  • SQL: A standardized programming language that is used to manage relational databases and perform various operations on the data.
  • PostgreSQL also known as Postgres, is a free and open-source relational database management system (RDBMS) emphasizing extensibility and SQL compliance.

UML Diagram structure

catalog_uml

Getting Started

  • Check the Ruby version or if you have at all by running ruby -v if you get something like this ruby 2.6.8p205 (2021-07-07 revision 67951) you have Ruby installed.
  • To clone the repo run the line git clone https://github.com/hannziegel/catalog.git on your console.
  • in the terminal do cd catalog
  • in the terminal do bundle install
  • to run the app, Run ruby main.rb in the terminal

Test

In the terminal, you can try running ruby by using rspec. To see the linters, you can try rubocop in the terminal.

Kindly modify the files as needed.

Authors ✍️

πŸ‘©β€πŸ’» Rodrigo Johann Reckziegel Nunes ✍️

πŸ‘¨β€πŸ’» Mustafa Fahimy ✍️

πŸ‘¨β€πŸ’» Riziki Bulambo Jean ✍️

🀝 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
  • Microverse
  • Inspiration
  • etc

πŸ“ License

This project is MIT licensed.