Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ruthmy/create-your-own-enumerable

This Ruby project is intended to serve as practice for implementing classes and modules that emulate a small set of Enumerable functionality.
https://github.com/ruthmy/create-your-own-enumerable

Last synced: 26 days ago
JSON representation

This Ruby project is intended to serve as practice for implementing classes and modules that emulate a small set of Enumerable functionality.

Awesome Lists containing this project

README

        


Create your own Enumerable | Ruby Project


# πŸ“— Table of Contents

- [πŸ“— Table of Contents](#-table-of-contents)
- [Create your own Enumerable ](#create-your-own-enumerable-)
- [πŸ›  Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [πŸš€ Live Demo ](#-live-demo-)
- [πŸ’» Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [πŸ‘₯ Authors ](#-authors-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [πŸ™ Acknowledgments ](#-acknowledgments-)
- [πŸ“ License ](#-license-)

---

# Create your own Enumerable

**"Create your own Enumerable"** is Ruby project is intended to serve as practice for implementing classes and modules that emulate a small set of Enumerable functionality.. This project is part of the Microverse curriculum.

---

## πŸ›  Built With

### Tech Stack

Ruby

---

### Key Features


  • Ruby

  • Linters

    • Rubocop



  • Follow Microverse's list of best practices

(back to top)

---

## πŸš€ Live Demo

- Unfortunately, there is no live demo available for this project at the moment.

(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:


  • A code editor (we recommend Visual Studio Code)



  • Git and a GitHub account


### Setup

Clone this repository to your desired folder by using this πŸ‘‡οΈ command :

```
git clone https://github.com/Ruthmy/create-your-own-enumerable.git
```

### Install

Go to the project directory:

```
cd create-your-own-enumerable
```

Before to run the program, verify that you have Ruby installed on your OS running the following command:

```
ruby -v
```

It should show you the version of ruby ​​installed. If this does not happen and only an error message is displayed, then you should either verify your installation or install Ruby from scratch.

[Download and Install Ruby](https://www.ruby-lang.org/en/downloads/)

### Usage

Run the following command inside the project folder:

```
ruby my_list.rb
```

This will display the following output:

```
true
false
true
false
[2, 4]
```

This is just a test code. If you want to test other lists, you must open the `my_list.rb` file using the code editor of your choice and change the argument in the `MyList.new()` object creation:

```
list = MyList.new(add-here-your-own-elements)
```

### Run tests

- Not aplicable.

### Deployment

- Not aplicable.

(back to top)

---

## πŸ‘₯ Authors

πŸ‘€ **Nitcelis Bravo**

- GitHub: [Nitcelis Bravo](https://github.com/NitBravoA92)
- Twitter: [@softwareDevOne](https://twitter.com/softwareDevOne)
- LinkedIn: [Nitcelis Bravo Alcala](https://www.linkedin.com/in/nitcelis-bravo-alcala-b65340158)

πŸ‘€ **Ruth Abreu**

- GitHub: [@Ruthmy](https://github.com/Ruthmy)
- Twitter: [@rury_exe](https://twitter.com/rury_exe)
- LinkedIn: [LinkedIn](https://linkedin.com/in/ruth-abreu)

(back to top)

---

## πŸ”­ Future Features

Upcoming improvements:

- [] Improve more functionalities from the Enumerable module.

(back to top)

---

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Ruthmy/create-your-own-enumerable/issues).

(back to top)

---

## ⭐️ Show your support

If you like this project and know someone who might find it helpful, please share it.
Or give it a **star** ⭐️ if you like this project!

(back to top)

---

## πŸ™ Acknowledgments

I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.

(back to top)

---

## πŸ“ License

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

(back to top)

---