Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iturres/oop_school_library_2

💎 Simple ruby app to manage school library.
https://github.com/iturres/oop_school_library_2

agregation associations oop-principles ruby

Last synced: 16 days ago
JSON representation

💎 Simple ruby app to manage school library.

Host: GitHub
URL: https://github.com/iturres/oop_school_library_2
Owner: ITurres
License: mit
Created: 2023-11-06T21:34:05.000Z (about 1 year ago)
Default Branch: development
Last Pushed: 2023-11-10T21:03:31.000Z (about 1 year ago)
Last Synced: 2024-11-29T10:07:15.354Z (23 days ago)
Topics: agregation, associations, oop-principles, ruby
Language: Ruby
Homepage:
Size: 275 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        



    

    OOP School Library 2



---

# 📗 Table of Contents

- [📖 About the Project](#about-project)

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

    - [Tech Stack](#tech-stack)

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

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Usage](#usage)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

---

# 📖 OOP School Library 

- The goal is to build a simple app using OOP and Ruby to manage a school library.

#### Learning objectives

- Use OOP to build a simple app.

- Implement classes and objects in Ruby.

- Implement encapsulation and inheritance with Ruby.

- Implement composition (as an example of the design pattern).

- Set up associations between classes and objects.

- Build interactive console apps.

- Add basic UI to a program.

- Run a program using the command line.

## 🛠 Built With 

### Tech Stack 

  


    

      

         Ruby

      

    

  


---

## 💻 Getting Started 

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

### Prerequisites

In order to run this project you need:

- Have Ruby installed. If you need to install Ruby, follow the instructions on the [official page](https://www.ruby-lang.org/en/documentation/installation/).

### Setup

Clone this repository to your desired folder:

Example commands:

- With SSH:

```bash

  cd my-folder

  git clone [email protected]:ITurres/oop_school_library_2.git

```

- With HTTPS:

```bash

  cd my-folder

  git clone https://github.com/ITurres/oop_school_library_2.git

```

- With GitHub CLI:

```bash

  cd my-folder

  gh repo clone ITurres/oop_school_library_2

```

### Usage

```bash

 cd ui/

  ruby main.rb

```

OR

```bash

ruby ui/main.rb

```

(back to top)


---

## 👥 Authors 

👤 **Arthur Iturres**

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

- LinkedIn: [Arthur Emanuel G. Iturres](https://www.linkedin.com/in/arturoemanuelguerraiturres/)

- Angellist / Wellfound: [Arturo (Arthur) Emanuel Guerra Iturres](https://wellfound.com/u/arturo-arthur-emanuel-guerra-iturres)

- Youtube: [Arturo Emanuel Guerra Iturres - Youtube Channel](https://www.youtube.com/channel/UC6GFUFHOtBS9mOuI8EJ6q4g)

- Portfolio: [Arthur Iturres - Portfolio](https://iturres.github.io/iturres-reactive-portfolio/)

(back to top)


---

## 🔭 Future Features 

- [x] Class Decorators.

- [x] Associations.

- [x] Basic UI.

- [ ] Preserve data.

- [ ] unit tests.

(back to top)


---

## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


---

## ⭐️ Show your support 

Give a ⭐ if you liked this project!

(back to top)


---

## 🙏 Acknowledgments 

I thank the **Code Reviewers** for their advice and time 🏆

(back to top)


---

## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)


---