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.

Create your own Enumerable | Ruby Project

📗 Table of Contents

• 📗 Table of Contents
• Create your own Enumerable
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 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

• Ruby Official Website

---

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

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
• Twitter: @softwareDevOne
• LinkedIn: Nitcelis Bravo Alcala

👤 Ruth Abreu

• GitHub: @Ruthmy
• Twitter: @rury_exe
• LinkedIn: LinkedIn

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

(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 licensed.

(back to top)

---