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

An app that was built with Ruby using OOP principles. The app allow you to add new students, teachers, books and save records of who borrowed a given book and when.
https://github.com/mohamedhnoor/oop-school-library

github-actions rspec rubocop ruby

Last synced: 8 days ago
JSON representation

An app that was built with Ruby using OOP principles. The app allow you to add new students, teachers, books and save records of who borrowed a given book and when.

• Host: GitHub
• URL: https://github.com/mohamedhnoor/oop-school-library
• Owner: MohamedHNoor
• License: mit
• Created: 2023-03-06T10:13:58.000Z (almost 2 years ago)
• Default Branch: development
• Last Pushed: 2023-03-13T13:59:19.000Z (almost 2 years ago)
• Last Synced: 2025-01-10T15:22:38.325Z (23 days ago)
• Topics: github-actions, rspec, rubocop, ruby
• Language: Ruby
• Homepage:
• Size: 33.2 KB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# 📗 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)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [❓ FAQ ](#-faq-)

  - [📝 License ](#-license-)

# 📖 OOP-school-library 

> An app that was built with Ruby using OOP principles. The app allow you to add new students, teachers, books and save records of who borrowed a given book and when.

## 🛠 Built With 

### Tech Stack 

  Server

  


    
Ruby

  


### Key Features 

- **Add new students or teachers**

- **Add new books.**

- **Save records of who borrowed a given book and when**

(back to top)


## 🚀 Live Demo 

- [Not Available]()

(back to top)


## 💻 Getting Started 

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

### Prerequisites

In order to run this project you need:

- Mac or PC

- Install Ruby

- Understanding OOP principles

### Setup

Clone this repository to your desired folder:

```sh

  cd your-folder

  https://github.com/MohamedHNoor/OOP-school-library.git

```

### Install

Install this project with:

- GitHub Actions

- Linters

  - Rubocop

- Ruby

### Usage

- The project can be used as a tool to record what books are in the library and who borrows them.

(back to top)


## 👥 Authors 

👤 **Mohamed Hassan Noor**

- GitHub: [@MohamedHNoor](https://github.com/MohamedHNoor)

- Twitter: [@MohamedHNoor](https://twitter.com/MohamedHNoor)

- LinkedIn: [@MohamedHNoor](https://www.linkedin.com/in/mohamedhnoor/)

👤 **Ameer Hamza**

- GitHub: [@githubhandle](https://github.com/ameerhamzakhalid)

- Twitter: [@twitterhandle](https://twitter.com/@ameeerhamza1997)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ameerhamzakhalid/)

(back to top)


## 🔭 Future Features 

- [ ] **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/MohamedHNoor/OOP-school-library/issues).

(back to top)


## ⭐️ Show your support 

If you like this project, please leave a ⭐️

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for providing the reading materials that aided me during the project development

(back to top)


## ❓ FAQ 

- **Can I use this code?**

  - yes, it is open source. Feel free to fork it.

- **Can I contribute to this project?**

  - Contact me so I can add you as a collaborator. Alternatively you can leave an issue, it will be well appreciated.

(back to top)


## 📝 License 

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)