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

https://github.com/kessie2862/enumerable

This repo showcases the implementation of a custom module called MyEnumerable and a corresponding class called MyList.
https://github.com/kessie2862/enumerable

enumerable rubocop ruby

Last synced: about 1 year ago
JSON representation

This repo showcases the implementation of a custom module called MyEnumerable and a corresponding class called MyList.

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 [Enumerable]

**Enumerable** showcases the implementation of a custom module called MyEnumerable and a corresponding class called MyList.

(back to top)

## 🛠 Built With

### Tech Stack

Language

### Key Features

- **Rubocop implemented**
- **Implement enumerable module**

(back to top)

## 💻 Getting Started

### Prerequisites

In order to run this project you need:
- To clone or fork this repo
- Ruby installed in your machine
- To modify this project you'll need a text editor

For more information on how to install ruby on your machine:
- How to install ruby

### Setup

Clone this repository to your desired folder:

```sh
cd project-folder
git clone https://github.com/kessie2862/Enumerable.git
```

For more information on how to clone or fork a repository:
- How to clone a repo
- How to fork a repo

### Install

To install dependencies, the following command must be run in the terminal:

```sh
cd Enumerable
rubocop
```

### Usage

In the project directory, you can run:

```sh
irb -r ./index.rb
```

### Run tests

No tests available

### Deployment

No deployment of this project

(back to top)

## 👥 Authors

👤 **Prosper Kessie**

- GitHub: [@kessie2862](https://github.com/kessie2862)
- LinkedIn: [Prosper Kessie](https://www.linkedin.com/in/prosperkessie/)

👤 **Antoine Makdessy**

- GitHub: [@ANTOINE1128](https://github.com/ANTOINE1128)
- LinkedIn: [Antoine (Tony) Makdessy](https://www.linkedin.com/in/antoine-makdessy/)

👤 **Deborah A. Fashoro**

- GitHub: [@DebyGrey](https://github.com/DebyGrey)
- LinkedIn: [Deborah Fashoro](https://www.linkedin.com/in/deborah-fashoro)

(back to top)

## 🔭 Future Features

Future changes:
- No changes

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project, I encourage you to clone, fork, and contribute.

(back to top)

## 🙏 Acknowledgments

We want to thank Microverse for the idea for this project.

(back to top)

## 📝 License

This project is [MIT](https://github.com/kessie2862/Enumerable/blob/dev/LICENSE) licensed.

(back to top)