sadaf-Daneshgar / school_library

[ OOP school library ] is a project that is part of the Microverse Ruby curriculum. The goal is to build a library system that can be used by students and teachers to check out books. The library has a limited number of copies for each book so it can only allow a certain number of people to check out the same book at the same time.

📗 Table of Contents

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

📖 [ OOP school library ]

[ OOP school library ] is a project that is part of the Microverse Ruby curriculum. The goal is to build a library system that can be used by students and teachers to check out books. The library has a limited number of copies for each book so it can only allow a certain number of people to check out the same book at the same time. The library also has a number of computers that can be used by students to read books online.

🛠 Built With

• ✅ Ruby
• ✅ Linters

Tech Stack

Language

• Ruby

Key Features

• 🔰 [ Person, Teacher and Student ]
• 🔰 [ Implement OOP principles like: abstraction, inhertance, polymorphism and encapsulation ]
• 🔰 [ Practice Ruby best practices ]

(back to top)

💻 Getting Started

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

1. Download or clone this repostory.
2. Provide a modern web browser.

Prerequisites

In order to run this project you need:

• ✔ Ruby installed in your machine. you can download it from here
• ✔ IDE or a code editor installed in your machine.
• ✔ IRB.
• ✔ Git installed in your machine.
• ✔ Sign in or sign up to your Github account.
• ✔ A professional editer such as VS Code.
• ✔ An Updated web browser such as Google Chrome, you can download it from here.

Setup

• Clone this repository to your desired folder:

• Example commands:

  cd [YOUR FOLDER]
  git clone https://github.com/sadaf-Daneshgar/school_library.git

Usage

• To run the project, execute the following command:

 cd [YOUR FOLDER]
 git clone https://github.com/sadaf-Daneshgar/school_library.git

Deployment

This project is deployed by the author, no permission for deployment by any other client.

(back to top)

👥 Authors

👤 Sadaf Daneshgar

• 👤 GitHub: @Sadaf-Daneshgar
• 👤 Twitter: @SadafDaneshgar
• 👤 LinkedIn: Sadaf Daneshgar

👤 Mohammad Yaser

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

(back to top)

🔭 Future Features

• [ Use the "Decorator" design pattern. ]
• [ Set up associations. ]
• [ Add basic UI. ]

(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, kindly drop a start ⭐️ for the repository;

(back to top)

🙏 Acknowledgments

I would like to thank the following individuals and organizations for their contribution to this project.

• I would like to express my heartfelt gratitude to Microvere for the invaluable learning experience they have provided.

(back to top)

📝 License

This project is MIT licensed.

(back to top)