Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/tomasesquivelgc/oop-library

This is a Library project using Ruby.
https://github.com/tomasesquivelgc/oop-library

Last synced: 10 days ago
JSON representation

This is a Library project using Ruby.

Awesome Lists containing this project

README

        

OOP library

# πŸ“— Table of Contents

- [πŸ“– About the Project](#about-project)
- [πŸ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [πŸ’» Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Run tests](#run-tests)
- [πŸ‘₯ Authors](#authors)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ™ Acknowledgements](#acknowledgements)
- [πŸ“ License](#license)

# πŸ“– OOP Library

**OOP Library** is a Ruby project that aims at the creation and management of a library.

## πŸ›  Built With

### Tech Stack

Client

### Key Features

- **Creation of "Person" objects (Student/Teachers)**
- **Decorator design**

(back to top)

## πŸ’» Getting Started

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

### Prerequisites

In order to run this project you need an Ubuntu console (WSL)

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]:tomasesquivelgc/OOP-Library.git
```

### Install

Install this project with:

```sh
cd my-project
bundle install
```

### Run tests

To run tests, run the following command:

```sh
cd project
ruby test_suite.rb
```

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Tomas Esquivel**

- GitHub: [@tomasesquivelgc](https://github.com/tomasesquivelgc)
- Twitter: [@EsquivelTomas](https://twitter.com/EsquivelTomas)
- LinkedIn: [Tomas Esquivel](https://www.linkedin.com/in/tomΓ‘s-esquivel-b2160568/)

πŸ‘€ **IvΓ‘n Gonzalez**

- GitHub: [@ivangonzalez224](https://github.com/ivangonzalez224)
- Twitter: [@Ivan Gonzalez](https://twitter.com/ivang2204)
- LinkedIn: [IvΓ‘n Gonzalez Robles](https://www.linkedin.com/in/ivΓ‘n-gonzalez-robles-957491275/)

πŸ‘€ **Karim David Barragan**

- GitHub: [@Rebelzob](https://github.com/Rebelzob)
- LinkedIn: [Karim David Barragan MontaΓ±a](https://www.linkedin.com/in/karim-barragan/)

(back to top)

## πŸ”­ Future Features

- [ ] **Library database**
- [ ] **associations**
- [ ] **basic UI**

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project please leave a star!

(back to top)

## πŸ™ Acknowledgments

I would like to thank Microverse for this oppportunity and all of my friends and family for always supporting me.

(back to top)

## πŸ“ License

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

(back to top)