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

https://github.com/tsheporamantso/opp-school-library

In this project I'll be building a school library application using ruby classes and objects and also implementing 4 ruby principles i.e. Abstraction, Encapsulation, inheritance and Polymorphism
https://github.com/tsheporamantso/opp-school-library

rubocop ruby rubygems

Last synced: 5 months ago
JSON representation

In this project I'll be building a school library application using ruby classes and objects and also implementing 4 ruby principles i.e. Abstraction, Encapsulation, inheritance and Polymorphism

Awesome Lists containing this project

README

          

OOP-School-Library

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 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)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 OOP-School-Library

**OOP-School-Library** is an school library app designed with Ruby where you can add teachers, students, books and see books borrow records.

![Alt text](image.png)

## 🛠 Built With

### Tech Stack

Server

### Key Features

- **Add functionality**
- **Record functionality**
- **Associations between classes and objects**

(back to top)

## 🚀 Live Demo

- Not live yet

(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:

- Install ruby using [link](https://www.ruby-lang.org/en/documentation/installation/#apt)

### Setup

Clone this repository to your desired folder:

```sh
mkdir folder_name
cd folder_name
git clone git@github.com:tsheporamantso/opp-school-library.git
```

### Install

Install this project with:

```sh
bundle install
```

### Usage

To run the project, execute the following command:
run the result on the terminal through:

```sh
ruby person.rb
ruby student.rb
ruby teacher.rb
```

### Run tests

No tests available.

### Deployment

Not deployed

(back to top)

## 👥 Authors

👤 **Gladwin Tshepo Ramantso**

- GitHub: [@tsheporamantso](https://github.com/tsheporamantso)
- Twitter: [@ramgt001](https://twitter.com/ramgt001)
- LinkedIn: [Tshepo Gladwin Ramantso](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/)

(back to top)

## 🔭 Future Features

- **Use the "Decorator" design pattern**
- **Set up associations**
- **Add basic UI**
- **Refactor code**
- **Preserve data**
- **Unit test**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project please give a star on [github](https://github.com/tsheporamantso/OOP-School-Library) & follow us on [twitter](https://twitter.com/ramgt001) and also connect on [Linkedin](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/).

(back to top)

## 🙏 Acknowledgments

I would like to thank:

- **Microverse and all the staff**
- **Microverse Communinity**
- **Thanks to my coding Partners**
- **Thanks to my Morning-Session-Group and Standup-Team Partners and**
- **Thanks to Code Reviewers**

(back to top)

## 📝 License

This project is [MIT](https://github.com/tsheporamantso/opp-school-library/blob/cb894dc26b4aca7747c10e5cedba2b6f62bfe9fa/LICENSE) licensed.

(back to top)