HFG43 / OOP-school-library

School Library is an app build on Ruby, to run on command line where you con add teachers, students, classrooms, and book and make rent of them.

School Library

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 School Library.

School Library is a library app created using Ruby to practice OOP and apply best practices.

🛠 Built With

Tech Stack

Ruby

• Ruby
• Ruby styles guide

Key Features

• Use Gitflow
• Implement classes and objects
• Use encapsulation and inheritance
• Ruby styles reviewed with Rubocop Linters
• Use composition
• Implement book & rental associations
• Built interactive console app
• Make sure it use SOLID, YAGNI, KISS, DRY principles
• Preserve data
• Run Unit tests using Rspec

(back to top)

💻 Getting Started

This repository includes files with ruby lenguage.

Prerequisites

In order to run this project you need to have Ruby installed, check this documentation in order to know how to install it.

Setup

Clone this repository to your desired folder:

cd my-folder https://github.com/HFG43/OOP-school-library git clone

Usage

To run the project, in your command line execute the following commands:

  ruby main.rb

To check the linters you can use the command:

  rubocop

To fix the linter use:

  rubocop --fix

(back to top)

👥 Author

👤 Hernán Güemes

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Franck Sefu

• GitHub: francksefu
• Twitter: francksefu
• LinkedIn: francksefu

(back to top)

🔭 Future Features

• Add Delete and Update options for stored data

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project you could clone the repo and work with it or do the changes in a new branch. Also you could let a message with your thoughts.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing the necessary resources for this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)