c00p75/oop-school-library

School Library is a Ruby practice project aimed at mastering Object Oriented Programming.

OOP School Library

📗 Table of Contents

• 📗 Table of Contents
• 📖 School Library
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started with school-library
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 School Library

School Library is a Ruby practice project aimed at mastering Object Oriented Programming.

🛠 Built With

Tech Stack

• Ruby
  Language

  • Ruby

Key Features

• [List all books]
• [List all books]
• [Create a person]
• [Create a book]
• [Create a rental]
• [List all rentals]

(back to top)

💻 Getting Started with school-library

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

Prerequisites

In order to run this project you need:

1. Ruby installed on your machine
2. Text editor (VSCode, Sublime, Atom, etc.)

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:c00p75/oop-school-library.git

Install

Install this project with:

  cd oop-school-library

Usage

Run this project with:

  ruby person.rb
  ruby student.rb
  ruby teacher.rb

Run tests

Run tests with:

  rubocop

(back to top)

👥 Authors

👤 George M'sapenda

• GitHub: @c00p75
• LinkedIn: George M'sapenda

👤 AmenMusingarimi

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

(back to top)

🔭 Future Features

• Add function to list books
• Add function to add books to the library
• Add UML diagram

(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, Give a ⭐️.

(back to top)

🙏 Acknowledgments

• Project from Microverse Ruby module

(back to top)

📝 License

This project is MIT licensed.

(back to top)