https://github.com/hfg43/oop-school-library
School Library is an app build on Ruby, to run on command line where you con add teachers, students, classrooms, and book and make rent of them.
https://github.com/hfg43/oop-school-library
ruby
Last synced: about 1 year ago
JSON representation
School Library is an app build on Ruby, to run on command line where you con add teachers, students, classrooms, and book and make rent of them.
- Host: GitHub
- URL: https://github.com/hfg43/oop-school-library
- Owner: HFG43
- License: mit
- Created: 2023-08-28T19:06:40.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-09-08T02:57:14.000Z (over 2 years ago)
- Last Synced: 2025-04-24T07:03:14.976Z (about 1 year ago)
- Topics: ruby
- Language: Ruby
- Homepage:
- Size: 46.9 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
School Library
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**School Library** is a library app created using Ruby to practice OOP and apply best practices.
Ruby
- **Use Gitflow**
- **Implement classes and objects**
- **Use encapsulation and inheritance**
- **Ruby styles reviewed with Rubocop Linters**
- **Use composition**
- **Implement book & rental associations**
- **Built interactive console app**
- **Make sure it use SOLID, YAGNI, KISS, DRY principles**
- **Preserve data**
- **Run Unit tests using Rspec**
This repository includes files with ruby lenguage.
### Prerequisites
In order to run this project you need to have Ruby installed, check [this](https://www.ruby-lang.org/en/) documentation in order to know how to install it.
### Setup
Clone this repository to your desired folder:
cd my-folder https://github.com/HFG43/OOP-school-library
git clone
### Usage
To run the project, in your command line execute the following commands:
```sh
ruby main.rb
```
To check the linters you can use the command:
```sh
rubocop
```
To fix the linter use:
```sh
rubocop --fix
```
👤 **Hernán Güemes**
- GitHub: [@githubhandle](https://github.com/HFG43)
- Twitter: [@twitterhandle](https://twitter.com/HFG_43)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/hern%C3%A1n-g%C3%BCemes-a440591b/)
👤 **Franck Sefu**
- GitHub: [francksefu](https://github.com/francksefu)
- Twitter: [francksefu](https://twitter.com/franck_sefu)
- LinkedIn: [francksefu](https://www.linkedin.com/in/franck-sefu/)
- [ ] **Add Delete and Update options for stored data**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/HFG43/OOP-school-library/issues).
If you like this project you could clone the repo and work with it or do the changes in a new branch. Also you could let a message with your thoughts.
I would like to thank Microverse for providing the necessary resources for this project.
This project is [MIT](./LICENSE) licensed.