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

School Library is a Ruby practice project aimed at mastering Object Oriented Programming.
https://github.com/c00p75/oop-school-library

rspec ruby

Last synced: 10 months ago
JSON representation

School Library is a Ruby practice project aimed at mastering Object Oriented Programming.

• Host: GitHub
• URL: https://github.com/c00p75/oop-school-library
• Owner: c00p75
• License: mit
• Created: 2023-05-15T13:10:33.000Z (about 3 years ago)
• Default Branch: dev
• Last Pushed: 2023-08-07T14:47:56.000Z (almost 3 years ago)
• Last Synced: 2025-01-13T15:33:52.248Z (over 1 year ago)
• Topics: rspec, ruby
• Language: Ruby
• Homepage: https://codesandbox.io/p/github/c00p75/oop-school-library/draft/sleepy-wind
• Size: 590 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
OOP School Library


![UML Class Diagram](https://github.com/microverseinc/curriculum-ruby/raw/main/oop/images/uml_class_diagram.png)

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 School Library ](#-school-library-)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [💻 Getting Started with school-library ](#-getting-started-with-school-library-)

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

# 📖 School Library 

**School Library** is a Ruby practice project aimed at mastering Object Oriented Programming.

## 🛠 Built With 

### Tech Stack 

- Ruby

  

    Language

    


      
Ruby

    

  


### Key Features 

- **[List all books]**

- **[List all books]**

- **[Create a person]**

- **[Create a book]**

- **[Create a rental]**

- **[List all rentals]**

(back to top)


## 💻 Getting Started with school-library 

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

### Prerequisites

In order to run this project you need:

1. Ruby installed on your machine

2. Text editor (VSCode, Sublime, Atom, etc.)

### Setup

Clone this [repository](git@github.com:c00p75/oop-school-library.git) to your desired folder:

```sh

  cd my-folder

  git clone git@github.com:c00p75/oop-school-library.git

```

### Install

Install this project with:

```sh

  cd oop-school-library

```

### Usage

Run this project with:

```sh

  ruby person.rb

  ruby student.rb

  ruby teacher.rb

```

### Run tests

Run tests with:

```sh

  rubocop

```

(back to top)


## 👥 Authors 

👤 **George M'sapenda**

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

- LinkedIn: [George M'sapenda](https://www.linkedin.com/in/georgemsapenda/)

👤 **AmenMusingarimi**

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

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

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

(back to top)


## 🔭 Future Features 

- Add function to list books

- Add function to add books to the library

- Add UML diagram

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project, Give a ⭐️.

(back to top)


## 🙏 Acknowledgments 

- Project from [Microverse](https://www.microverse.org/?grsf=i6yi2m) Ruby module

(back to top)


## 📝 License 

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

(back to top)