OOP_School_Library

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

OOP_School_Library

★ 11 Open GitHub ↗

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.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 📗 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 <a name="about-project"></a>

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 <a name="built-with"></a>

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

### Tech Stack <a name="tech-stack"></a>

The project is built using the following technologies:

### Key Features <a name="key-features"></a>

- **Classes**
- **Rubocop install**
- **Gems install**
- **"Decorator" design pattern**
- **Associations**
- **Basic UI**
- **Refactor of code**
- **Preserve data**
- **Unit tests**

(<a href="#readme-top">back to top</a>)

## 💻 Getting Started <a name="getting-started"></a>

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 <a name="setup"></a>

Navigate to the project folder:
   
   cd OOP_School_Library

### Prerequisites <a name="prerequisites"></a>

- 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 <a name="usage"></a>

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 <a name="authors"></a>

👤 **Claudia Rojas**

-   GitHub: [@githubhandle](https://github.com/ClaudiaRojasSoto)
-   LinkedIn: [LinkedIn](https://www.linkedin.com/in/claudia-rojas-soto/)

(<a href="#readme-top">back to top</a>)

## 🔭 Future Features <a name="future-features"></a>

- [ ] **Book Recommendations**
- [ ] **Notifications System**

(<a href="#readme-top">back to top</a>)

## 🤝 Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome!

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

(<a href="#readme-top">back to top</a>)

## ⭐️ Show your support <a name="support"></a>

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

(<a href="#readme-top">back to top</a>)

## 🙏 Acknowledgments <a name="acknowledgements"></a>

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

OOP_School_Library

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README