/My-Enumerable

Primary LanguageRubyMIT LicenseMIT

Enumerable Module

📗 Table of Contents

📖 Enumerable Module

This project was built in order to learn how to use modules and include them inside a class. The whole project was written in Ruby, using Rubocop as linter an tester.

To learn how to include module methods inside a class we create a class named my_list and a module called my_enumerable which contains a set of functionalities that are tested in the test.rb file.

🛠 Built With

Tech Stack

Languajes

Key Features

  • [Has a set of functionalities]
  • [Uses yield and blocks]
  • [Written in Ruby]

Getting Started

This repository includes the file that is used to decode the message:

  • Use test to run the tests and try the functionality.

Setup

Clone this repository to your desired folder:

1 - Go to the <> Code section in the repository.

2 - Select the https tab and copy the url provided.

3 - Use the git clone command in the root of the folder where you will save the project.

Note: For more information you can visit About remote Repositories and Adding and cloning repositories.

Prerequisites

In order to run this project you need:

Install

This project just needs a Ruby interpreter. However, it uses RuboCop as a tester and as linter. You can install it with the following command: bundle install

Usage

To make use of the project, you must be able to run Ruby code in your computer. One way of doing this is by Installing WSL (if you are on Windows) and using the IRB terminal to run the code Another way is by running ruby test.rb In your wsl terminal.

Test

To run the tests, you need to execute the following command: rubocop

(back to top)

👥 Author: Hernán Zamora

👥 Author: Nshanji Hilary Ndzi

(back to top)

🔭 Future Features

  • [Enable the user to enter data]
  • [Building Front-End]

(back to top)

🚀 Live Demo

  • [N/A]

🎥 Project Presentation

  • [N/A]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page. Or send them directly to me.

(back to top)

⭐️ Show your support

If you like this project feel free to let me know via Linkedin - Github - Twitter, also don't forget to leave your ⭐️. I will always appreciate your comments.

(back to top)

🙏 Acknowledgments

  • Templete used in project provided by Microverse.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)