https://github.com/lordksix/library-ruby
This is a school library app coded in ruby.
https://github.com/lordksix/library-ruby
Last synced: about 2 months ago
JSON representation
This is a school library app coded in ruby.
- Host: GitHub
- URL: https://github.com/lordksix/library-ruby
- Owner: lordksix
- License: mit
- Created: 2023-07-25T00:34:54.000Z (almost 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-08-04T23:31:11.000Z (almost 2 years ago)
- Last Synced: 2024-05-17T15:48:26.618Z (about 1 year ago)
- Language: Ruby
- Size: 53.7 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
School Library App
# 📗 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)
- [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)
**School Library App** is our own enumerable module.
Programming language
- **Gitflow**
- **Rubocop implemented**
- **Implement School Library App**
- **Implement Person, Student and Teacher Class**
- **Implement inheritance**
- **Implement decorator deisgn pattern**
- **Implement book, rental and classroom Class**
- **Implement associations**
- **Implement application class with driver methods**
- **Implement main.rb to run application**
### Prerequisites
In order to run this project you need:
- To clone or fork this repo
- Ruby installed in your machine
- To modify this profile you will also need a text editor
For more information on how to install ruby on your machine:
- How to install ruby
### Setup
Clone this repository to your desired folder:
For example, using Ubuntu:
```sh
cd my-desired-folder
git clone https://github.com/lordksix/school-ruby.git
```
For more information on how to clone or fork a repository:
- How to clone a repo
- How to fork a repo
### Install
To install dependencies, the following command must be run in the terminal:
```sh
cd school-ruby
rubocop
```
### Usage
In the project directory, you can run:
```sh
ruby main.rb
```
### Run tests
No tests available
### Deployment
No deployment of this project
👤 **lordksix**
- GitHub: [@lordksix](https://github.com/lordksix)
- LinkedIn: [@wladpasquel](https://www.linkedin.com/in/wladpasquel/)
- Medium: [@wladimir.pasquel](https://medium.com/@wladimir.pasquel)
Future changes:
- Implement ui
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.
We would like to thank Microverse for the idea for this project.
- **Do I need a IDE or a special text editor to make changes?**
- No, you don't. You can use NotePad to make changes.
This project is [MIT](./LICENSE) licensed.