Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/bornittah/enumerable

learn how to use a module inside the class
https://github.com/bornittah/enumerable

Last synced: 6 days ago
JSON representation

learn how to use a module inside the class

Awesome Lists containing this project

README

        

# enumerable

# πŸ“— 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](#triangular_flag_on_post-deployment)
- [πŸ‘₯ Authors](#authors)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ™ Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [πŸ“ License](#license)

# πŸ“– [Enumerable]

In this project you will learn how to use a module inside your class. For this you will create a class `MyList` and a module `MyEnumerable`. Your module `MyEnumerable` will implement a subset of the functionality of [Enumerable](https://ruby-doc.org/core-3.0.0/Enumerable.html).

## πŸ›  Built With

### Tech Stack

Client

### Key Features

- **Use a module inside your class.**

(back to top)

## πŸš€ Live Demo

No Live demo

(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 to have basic knowledge of
- using code editor like vscode
- Ruby
- Git, Github, & Gitflow

### Setup

Clone this repository to your desired folder:

`https://github.com/Bornittah/enumerable.git`

### Install

Install this project with:

ubuntu
`sudo apt install libyaml-dev`

`rbenv install 3.2.0`

### Usage

To run the project, execute the following command in your terminal:

`rbenv`

### Run tests

No tests implemented

### Deployment

No deployment

(back to top)

## πŸ‘₯ Authors
πŸ‘€ **Agasha Bornittah**

- GitHub: [@Bornittah](https://github.com/Bornittah)
- Twitter: [@AgashaBornittah](https://twitter.com/AgashaBornittah)
- LinkedIn: [Bornittah](www.linkedin.com/in/agasha-bornittah)

πŸ‘€ **Maaloum Ely Cheikh**

- GitHub: [@githubhandle](https://github.com/maaloum)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)

(back to top)

## πŸ”­ Future Features

- [ ] **Implement more enumetable methods**

(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

We would like to appreciate
- Microverse for giving us opportunity to learn
- Code Reviewers & Coding Partners for their contribution to this project.
- Hat tip to anyone whose code was used.

(back to top)

## ❓ FAQ

- **[How to learn ruby?]**

- Read ruby [documentation](ruby-lang.org/en/documentation/)

(back to top)

## πŸ“ License

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

(back to top)