/school-library

Ruby OOP school library

Primary LanguageRubyMIT LicenseMIT

OOP school library

this is an OOP school library, with separated clases, that uses the 4 pillars of OOP: abstraction, encapsulation, inheritance and polymorphism.

Features

  • linters configured
  • bundle inited
  • tests configured
  • add classes related to OOP

Built with

  • Ruby

Linters

  • local linters: run in terminal inside the folder: rubocop
  • quick fix local linters: run in terminal inside the folder: rubocop --fix

Testing

  • automatically run tests in Github Actions

Debugging

  • add breakpoints to the code inside the file you want to debug
  • in the CLI run the next command: rdebug-ide {filename} (for example: rdebug-ide main.rb)
  • with the file to debug opened in the VSCode, press F5 to run the code
  • remember to close the debug window when you finish debugging

Prerequisites

  • ruby installed
  • VSCode

Installation

  • first, clone the project to your local machine: git clone https://github.com/Wikitelmex/school-library.git
  • then, open the terminal and run the following command: cd school-library && bundle install
  • type code . to open the project in VSCode

Usage

  • in a VSCode terminal run the following command: ruby main.rb to start the program

Author

👤 Alex Castillo

🤝 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!

📝 License

This project is MIT licensed.