Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/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.
https://github.com/sadaf-daneshgar/school_library

aggregation association inheritance oop-programming ruby ul unit-testing

Last synced: 11 days ago
JSON representation

[ 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.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#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](https://github.com/sadaf-Daneshgar/school_library.git).
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](https://www.ruby-lang.org/en/downloads/)
- ✔ IDE or a code editor installed in your machine.
- ✔ IRB.
- ✔ [Git](https://git-scm.com/downloads) installed in your machine.
- ✔ Sign in or sign up to your [Github](https://github.com/) account.
- ✔ A professional editer such as [VS Code](https://code.visualstudio.com/download).
- ✔ An Updated web browser such as Google Chrome, you can download it from [here](https://www.google.com/chrome/).

### Setup

- Clone this [repository](https://github.com/sadaf-Daneshgar/school_library) to your desired folder:

- Example commands:

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

### Usage

- To run the project, execute the following command:

```sh
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](https://github.com/sadaf-Daneshgar)
- 👤 Twitter: [@SadafDaneshgar](https://twitter.com/SadafDaneshgar)
- 👤 LinkedIn: [Sadaf Daneshgar](https://www.linkedin.com/in/sadaf-daneshgar-2002saba/)

👤 **Mohammad Yaser**

- GitHub: [@githubhandle](https://github.com/MohammadYaser)
- Twitter: [@twitterhandle](https://twitter.com/Yaser_Safi19)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mohammad-yaser-safi-a12083270)

(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](https://github.com/sadaf-Daneshgar/school_library/issues).

(back to top)

## ⭐️ Show your support

If you like this project, kindly drop a start ⭐️ for the [repository](https://github.com/sadaf-Daneshgar/school_library);

(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**](https://www.microverse.org/?grsf=mohammad-a-nbtazu) for the invaluable learning experience they have provided.

(back to top)

## 📝 License

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

(back to top)