Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rileymanda/morse-code

Morse Code is a simple application with methods for decoding strings of morse code into english and vice versa. It is built with Ruby.
https://github.com/rileymanda/morse-code

ruby

Last synced: about 6 hours ago
JSON representation

Morse Code is a simple application with methods for decoding strings of morse code into english and vice versa. It is built with Ruby.

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)

- [🚀 Project Presentation](#project-presentation)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 Attribution](#attribution)
- [📝 License](#license)

# 📖 Morse Code

Morse Code is a simple application with methods for decoding strings of morse code into english and vice versa. It is built with Ruby.
## 🛠 Built With

### Tech Stack

Ruby

## 🛠 Key Features
### Features

**Decode Morse Code methods**

(back to top)

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

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/RileyManda/morse-code.git
```

### Install

Install this project with:

```sh
irb
load decoding_morse
```

### Usage

To run the project, execute the following terminal command:

```sh
irb
load decoding_morse
```

### Run tests

To run tests, run the following command:

```sh
irb
```

```sh
load decoding_morse
```

```sh
decode_char('.-')
decode_word('-- -.--')
decode_message("-- -.-- -. .- -- .")
decode_message(".- -... --- -..- ..-. ..- .-.. .-.. --- ..-. .-. ..- -... .. . ...")
```

### Deployment

You can deploy this project using:

```sh
npm run build
```
```sh
gh-pages deploy --dist build
```

(back to top)

## 👥 Authors

👀 **RileyManda**

- GitHub: [@RileyManda](https://github.com/RileyManda)
- Twitter: [@rilecodez](https://twitter.com/rileycodez)
- LinkedIn: [rileymanda](https://www.linkedin.com/in/rileymanda/)

👀 ClarenceAtim

- GitHub: [@kit0-0](https://github.com/ClarenceAtim)

(back to top)

## 🔭 Future Features

- [ ] **[front end]**

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/RileyManda/morse-code/issues)

(back to top)

## Show your support 🌟

Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:

- Star the project ⭐: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.

- Fork the project 🍎 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.

- Share with others 🗺: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.

(back to top)

## 🙏 Acknowledgments

I would like to express my sincere gratitude to [Microverse](https://github.com/microverseinc), the dedicated reviewers, and collaborators. Your unwavering support, feedback, and collaborative efforts have played an immense role in making this journey a resounding success. I am truly grateful for your contributions and for being an integral part of my achievements.

Thank you for your continued support.

(back to top)

## ❓ FAQ

- **Question_1**

Do I have to use the vs code specifically?

- Answer_1

You can use any code editor of your choice.

- **Question_2**

Where can I download node JS for installation?

- Answer_2

Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
It can be downloaded [here](https://nodejs.org/en).

(back to top)

## 📝 License

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE.txt)

(back to top)