https://github.com/claudiarojassoto/oop_school_library

Welcome to the School_Library project! This application serves as a tool for librarians at OOP University to manage their book records and track book borrowings.
https://github.com/claudiarojassoto/oop_school_library

classes gem gemfile inheritance modules oop rubocop ruby ui

Last synced: 2 months ago
JSON representation

Welcome to the School_Library project! This application serves as a tool for librarians at OOP University to manage their book records and track book borrowings.

• Host: GitHub
• URL: https://github.com/claudiarojassoto/oop_school_library
• Owner: ClaudiaRojasSoto
• License: mit
• Created: 2023-08-28T16:10:49.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2023-12-23T00:09:47.000Z (over 1 year ago)
• Last Synced: 2025-03-29T22:21:59.481Z (3 months ago)
• Topics: classes, gem, gemfile, inheritance, modules, oop, rubocop, ruby, ui
• Language: Ruby
• Homepage:
• Size: 63.5 KB
• Stars: 11
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        



# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 OOP\_School\_Library ](#-oop_school_library-)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [💻 Getting Started ](#-getting-started-)

  - [Setup ](#setup-)

    - [Prerequisites ](#prerequisites-)

- [Usage of Ruby ](#usage-of-ruby-)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 OOP_School_Library 

Welcome to the OOP_School_Library project! This application serves as a tool for librarians at OOP University to manage their book records and track book borrowings.

## 🛠 Built With 

The project is built using ruby. Getting Started Follow these steps to understand and work on the project:

### Tech Stack 

The project is built using the following technologies:

Ruby

  


    
Ruby

  


### Key Features 

- **Classes**

- **Rubocop install**

- **Gems install**

- **"Decorator" design pattern**

- **Associations**

- **Basic UI**

- **Refactor of code**

- **Preserve data**

- **Unit tests**

(back to top)


## 💻 Getting Started 

To get a local copy up and running, follow these steps.

Clone this repository to your local machine:

```

git clone https://github.com/ClaudiaRojasSoto/OOP_School_Library.git

```

## Setup 

Navigate to the project folder:

   

   cd OOP_School_Library

   

### Prerequisites 

- An integrated development environment (IDE) like Visual Studio Code.

- Ruby installed on your machine.

- Git installed on your machine.

- A GitHub account for version control.

# Usage of Ruby 

Follow these steps to use the program:

1. Open your terminal.

2. Navigate to the directory where the program files are located using the `cd` command.

bash

cd /path/to/your/program/files

3. To create a Person, Book or Rental object, use the following syntax:

**ruby main.rb**

You will see the following output in the console:

Welcome to OOP School Library Application!

Please choose an option by entering a number: 

1 - List all books

2 - List all people

3 - Create a person(student or teacher)

4 - Create a book

5 - Create a rental

6 - List all rentals for a given person id

7 - Exit

7. Enter the number corresponding to the option you want to execute and press Enter.

That's it! You've successfully executed the program.

Remember to replace `/path/to/your/program/files` with the actual path to the directory where your program files are located.

## 👥 Authors 

👤 **Claudia Rojas**

-   GitHub: [@githubhandle](https://github.com/ClaudiaRojasSoto)

-   LinkedIn: [LinkedIn](https://www.linkedin.com/in/claudia-rojas-soto/)

(back to top)


## 🔭 Future Features 

- [ ] **Book Recommendations**

- [ ] **Notifications System**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ClaudiaRojasSoto/OOP_School_Library/issues).

(back to top)


## ⭐️ Show your support 

If you like this project or if it helped you, please give a ⭐️. I'd really appreciate it!

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse and all my peers and colleagues at Microverse for giving me the opportunity to work on this project.

(back to top)


(back to top)


## 📝 License 

This project is [MIT](MIT.md).

(back to top)