Enumerable Ruby

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Enumerable Ruby

This project demonstrates the implementation of a custom Enumerable module in Ruby. It includes a MyList class that utilizes the MyEnumerable module to provide functionality similar to the methods in the Enumerable module.

🛠 Built With

Tech Stack

The project is built with the following technologies:

• Ruby

(back to top)

Key Features

The key features of this project include:

• Implementation of MyList class and MyEnumerable module
• Custom each, all?, any?, and filter methods

(back to top)

💻 Getting Started

To get started with the project, follow the instructions below.

Setup

To set up the project locally, you need to have Ruby installed on your system.

Prerequisites

• Ruby (version 2.5 or above)

Install

1. Clone the repository:

  clone [email protected]:emhamza/Enumerable-Ruby.git

2. Change into the project directory:

cd Enumerable-Ruby
bundle install

Usage

Modify and run the ruby files to utilize the MyList class and test the methods.

ruby my_list.rb
ruby my_enumerable.rb

4. The output will be printed on the console.

Run tests

There are no tests available for this project.

Deployment

There is no specific deployment process for this project as it is a code implementation. However, you can integrate project into your own Ruby applications.

(back to top)

👥 Author

This project was developed by:

👤 Mussie Kahsay

• GitHub: @MussieTeka
• Twitter: @MussieTeka
• LinkedIn: @MussieTeka

👤 Umair Hamza

• GitHub: @emhamza
• Twitter: @uhamzaz
• LinkedIn: Umair Hamza

(back to top)

🔭 Future Features

Possible future features for this project include:

• Add more methods to the MyEnumerable module
• Enhance error handling and edge case scenarios

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

If you would like to contribute to this project, you can follow these steps:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them.
4. Push your changes to your forked repository.
5. Create a pull request back to the original repository.

(back to top)

⭐️ Show your support

If you like this project, please give it a star on GitHub.

(back to top)

🙏 Acknowledgments

• Ruby
• GitHub
• Microverse

(back to top)

❓ FAQ (OPTIONAL)

• Can I modify and redistribute this project?

  • Yes, you can modify and redistribute this project as long as you follow the terms of the MIT license.

• How can I contribute to this project?

  • Contributions, issues, and feature requests are welcome! You can check the issues page to see if there are any current issues or feature requests that you can work on. If not, feel free to submit a new issue or pull request. Before contributing, please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)