https://github.com/iamsjunaid/oop-school-library
Practicing Ruby: classes and objects
https://github.com/iamsjunaid/oop-school-library
Last synced: 10 months ago
JSON representation
Practicing Ruby: classes and objects
- Host: GitHub
- URL: https://github.com/iamsjunaid/oop-school-library
- Owner: iamsjunaid
- License: mit
- Created: 2023-07-31T05:34:39.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-08-09T14:26:37.000Z (almost 3 years ago)
- Last Synced: 2025-01-13T14:53:06.143Z (over 1 year ago)
- Language: Ruby
- Size: 47.9 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- 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)
- [📖 About ](#-about-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 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-)
- [🙏 Acknowledgement ](#acknowledgement)
- [📝 License ](#-license-)
# 📖 About
_**OOP school library**_ built with [Ruby](https://www.ruby-lang.org/en/). In this project I have created:
1. `person.rb`
- Base class or parent class: contains the common attributes and methods of all the other classes.
2. `student.rb`
- Inherits from person class
- Contains the attributes and methods specific to students.
3. `teacher.rb`
- Inherits from person class
- Contains the attributes and methods specific to teachers.
## 🛠 Built With
Client
- Add new students or teachers.
- Add new books.
- Save records of who borrowed a book and when.
- Use the Decorator design pattern.
### Prerequisites
In order to run this project you need:
- [Ruby](https://www.ruby-lang.org/en/) installed and running. To get more information, read the [installation instructions](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md).
- You should be able to use [IRB](https://en.wikipedia.org/wiki/Ruby_(programming_language)#Features).
### Setup
Clone this repository to your desired folder:
```
git clone git@github.com:iamsjunaid/oop-school-library.git
cd enumerator
```
### Install
Install project dependencies with:
```
bundle install
```
To run the project, instantiate the class files in `main.rb` and execute the following command:
```
ruby main.rb
```
## 👥 Authors
👤 **Junaid Syed**
- GitHub: [@iamsjunaid](https://github.com/iamsjunaid)
- LinkedIn: [@JunaidAhmedSyed](https://www.linkedin.com/in/junaidahmedsyed/)
👤 **Nahid Raihan Sardar**
- GitHub: [@githubhandle](https://github.com/Nahid1911)
- Medium: [Medium](https://medium.com/@nahid.raihan)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/nahidraihan/)
- Twitter: [Twitter](https://twitter.com/Nahid1911)
- I'll be adding some additional methods to this project.
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/iamsjunaid/oop-school-library/issues).
If you like this project and want to support me make cooler projects Give this project a Star.
I would like to thanks [Microverse](https://www.microverse.org/).
This project is [MIT](https://github.com/iamsjunaid/oop-school-library/blob/dev/LICENSE) licensed.