An open API service indexing awesome lists of open source software.

https://github.com/kanzatahreem/oop-school-library

The OOP School Library app allows users to keep a record of books that are present in library and who borrows them. It also allows to add new students, teachers, and books
https://github.com/kanzatahreem/oop-school-library

books console-app design-patterns oop-principles rentals ruby school-library students teachers

Last synced: about 1 year ago
JSON representation

The OOP School Library app allows users to keep a record of books that are present in library and who borrows them. It also allows to add new students, teachers, and books

Awesome Lists containing this project

README

          

![](https://img.shields.io/badge/Microverse-blueviolet)

# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 OOP School Library ](#-oop-school-library-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage ](#usage-)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 OOP School Library
Imagine that you are the librarian of _OOP University_, and you need a tool to record the data of books that are present in the library and who borrows them. The _**OOP School Library**_ app will help you to record the data. It is a **Ruby console app** that allows you to

- Add new students or teachers.
- Add new books.
- Save records of who borrowed a given book and when.

## 🛠 Built With

### Tech Stack

Client

### Key Features

- Add new students or teachers.
- Add new books.
- Save records of who borrowed a book and when.
- Use the `Decorator` design pattern.

(back to top)

## 🚀 Live Demo

- N/A

(back to top)

## 💻 Getting Started

### Prerequisites

In order to run this project you need:

- [Ruby](https://www.ruby-lang.org/en/) installed and running. To get more information, read the [installation instructions](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md).
- You should be able to use [IRB](https://en.wikipedia.org/wiki/Ruby_(programming_language)#Features).
### Setup

Clone this repository to your desired folder:

```
git clone git@github.com:KanzaTahreem/OOP-School-Library.git
cd OOP-School-Library
```

### Install

Install thr project dependencies with:

```
bundle install
```

### Usage

To run the project, execute the following command:

```
ruby [file_name].rb
```

### Run tests

To run tests, run the following command:

```
rspec *_rspec.rb
```

(back to top)

## 👥 Authors

👤 **Kanza Tahreem**

- GitHub: [@KanzaTahreem](https://github.com/KanzaTahreem)
- Twitter: [@kanza_tahreem](https://twitter.com/kanza_tahreem)
- LinkedIn: [Kanza Tahreem](https://www.linkedin.com/in/kanza-tahreem/)

👤 **Mahdi Aghaali**
- GitHub: [@MahdiAghaali](https://github.com/MahdiAghaali)
- Twitter: [@Mohi_Aghaali](https://twitter.com/Mohi_Aghaali)
- LinkedIn: [mahdi-aghaali](https://www.linkedin.com/in/mahdi-aghaali/)

(back to top)

## 🔭 Future Features

- Add more tests

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/KanzaTahreem/OOP-School-Library/issues).

(back to top)

## ⭐️ Show your support

If you like this project and want to support me make cooler projects Give this project a Star.

(back to top)

## 🙏 Acknowledgments

Thank you to microverse for setting us on this journey.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)