https://github.com/adel-gu/oop-school-library
https://github.com/adel-gu/oop-school-library
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/adel-gu/oop-school-library
- Owner: adel-gu
- Created: 2022-12-19T09:13:54.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-02T16:48:35.000Z (over 2 years ago)
- Last Synced: 2025-01-13T16:47:31.342Z (4 months ago)
- Language: Ruby
- Size: 570 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📗 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)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [📝 License](#license)
This repo is a school library tool that allows you to record what books are in the library and who borrows them, the project focused on practicing the main four concepts in oop using ruby.
- The project built using Ruby
The app allows you to:
- Add new students or teachers.
- Add new books.
- Save records of who borrowed a given book and when.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Ruby should be installed localy in your system.
- You need a code editore such as `VsCode`.
### Setup
Clone this repository to your desired folder:
Example commands:
```sh
cd my-folder
git clone [email protected]:adel-gu/OOP-School-Library.git
```
### Install
Install this project with:
Example command:
```sh
cd my-project
bundle install
```
### Usage
To run the project, execute the following command:
Example command:
```sh
ruby main.rb
```
For more information on how you can use this app, please follow this [tutorial](https://www.youtube.com/watch?v=vkkgrhD6aXQ)
👤 **Adel Guitoun**
- GitHub: [@adel-gu](https://github.com/adel-gu)
- Twitter: [@GuitounAdel](https://twitter.com/GuitounAdel)
- LinkedIn: [adelguitoun](https://linkedin.com/in/adelguitoun)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## ⭐️ Show your support (back to top)
This project is [MIT](./MIT.md) licensed.