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

A ruby project to learn Object Oriented Programming
https://github.com/newhoteng/oop-school-library

Last synced: 24 days ago
JSON representation

A ruby project to learn Object Oriented Programming

• Host: GitHub
• URL: https://github.com/newhoteng/oop-school-library
• Owner: newhoteng
• License: mit
• Created: 2023-06-19T20:09:56.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-07-01T21:36:06.000Z (over 1 year ago)
• Last Synced: 2024-10-23T19:23:46.409Z (2 months ago)
• Language: Ruby
• Size: 48.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

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)

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Usage](#usage)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

- [⭐ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

#  :open_book: OOP-school-library 

OOP-school-library is a ruby project to learn Object Oriented Programming

## :hammer_and_wrench: Built With 

### Tech Stack

Client



  
Ruby



### Key Features

  - `Person` class

  - `Student` class

  - `Teacher` class

  - `Nameable` class

  - `Decorator` class

  - `CapitalizeDecorator` class

  - `TrimmerDecorator` class

  - `Classromm` class

  - `Book` class

  - `Rental` class

  - Basic UI to run `school library`

(back to top)


## :computer: Getting Started 

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


### Prerequisites

In order to run this project you need:

- [Ruby](https://www.ruby-lang.org/en/) installed on your machine

- Text editor (VScode)

### Setup

Clone this repository to your desired folder:


```

git clone https://github.com/newhoteng/OOP-school-library.git

```

### Usage

To run the project, execute the following command:


- Type `irb` inside the termimal to open Interactive Ruby

- Copy and paste expressions from `.rb` files into terminal and check their results (press enter after typing each one)

(back to top)


## :busts_in_silhouette: Authors 

:bust_in_silhouette: **Harriet Oteng**

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

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

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

👤 **Seyi Oyemade**

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

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

- LinkedIn: [Seyi Oyemade](https://www.linkedin.com/in/seyi-oyemade)

(back to top)


## :telescope: Future Features 

  - Add more classes

  - Add more class methods

(back to top)


## :handshake: Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/newhoteng/OOP-school-library/issues).

(back to top)


## :star: Show your support 

If you like this project give it a star.

(back to top)


## :pray: Acknowledgements 

- Thanks to Microverse for the encouragement

(back to top)

  

## :memo: License 

[License](https://github.com/newhoteng/OOP-school-library/blob/main/LICENSE)