https://github.com/tsohledev/oop-school-library
A library created Object Orientated Programming paradigm
https://github.com/tsohledev/oop-school-library
oop-principles ruby
Last synced: over 1 year ago
JSON representation
A library created Object Orientated Programming paradigm
- Host: GitHub
- URL: https://github.com/tsohledev/oop-school-library
- Owner: tsohleDev
- License: mit
- Created: 2023-03-08T20:59:11.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-10T09:29:19.000Z (over 3 years ago)
- Last Synced: 2025-01-21T04:32:20.296Z (over 1 year ago)
- Topics: oop-principles, ruby
- Language: Ruby
- Homepage:
- Size: 25.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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)
- [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)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
> About this repository
**OOP School Library** is a console app used to demostrate the use of Object Orientated Programming Paradigm in ruby, we create a library where we can record what books are in the library and who borrows them
> My stack is consists only of the client side framework
Backend
> Describe between 1-3 key features of the application.
- **[Create Teacher and Student Objects which inherits from Person object]**
- **[Borrow book from the library]**
- **[Add/remove book from library]**
> How to clone and use this project project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- VSCode or any other equivalent code editor
- Ruby and IRB
### Linux
```sh
sudo apt install ruby
```
### windows
[Download Ruby and IRB](https://ruby-lang.org/)
### Setup
Clone this repository to your desired folder:
- Open the command prompt in the created directory.
- On the terminal run this command
```sh
git clone https://github.com/tsohleDev/OOP-School-Library.git
```
- Go to the repository folder using command prompt
```sh
cd OOP-School-Library
```
### Install
Install this project with:
```sh
bundle install
```
### Usage
To run the project, execute the following command:
```sh
irb
```
> All of the collaborators of this project.
👤 **Tsohle Mokhemisi**
- GitHub: [@githubhandle](https://github.com/tsohleDev2)
- Twitter: [@twitterhandle](https://twitter.com/RealTsohle)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/tsohle-mokhemisi-3687401b2/)
> Describe 1 - 3 features you will add to the project.
- **[Create a console app to interact with the app]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> To support this project
Give a ⭐️ if you like this project!
> Credits to everyone who inspired the codebase.
I would like to thank [Microverse](https://microverse.org) for the great content
This project is [MIT](./LICENSE) licensed.