https://github.com/kylewelsby/mindful-chef-coding-challenge
Code challenge for Mindful Chef
https://github.com/kylewelsby/mindful-chef-coding-challenge
code-challenge
Last synced: 28 days ago
JSON representation
Code challenge for Mindful Chef
- Host: GitHub
- URL: https://github.com/kylewelsby/mindful-chef-coding-challenge
- Owner: kylewelsby
- License: mit
- Created: 2023-05-30T20:17:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-01T08:59:28.000Z (over 2 years ago)
- Last Synced: 2025-01-20T15:20:44.671Z (about 1 year ago)
- Topics: code-challenge
- Language: Ruby
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mindful Chef Code Challenge
This repository contains the solution to the
[Mindful Chef Code Challenge](./CHALLENGE.md) completed by
[Kyle Welsby](https://github.com/kylewelsby). The challenge involved building a
warehouse robot controller.
## ⚡️ System Dependencies
Before using the warehouse robot controller, make sure you have the following
dependencies installed on your system:
- [Deno](https://deno.land): The runtime environment required to build and run
the tool.
- (alternative) [Ruby](https://www.ruby-lang.org/en/): The alternative runtime
environment to run the tool.
_At the time of writing the latest stable version of Deno is 1.34.1, or Ruby
3.3.0_
## 🚀 Getting Started
Follow the steps below to get started with the warehouse robot controller:
1. Clone this repository to your local machine:
```bash
git clone https://github.com/kylewelsby/mindful-chef-code-challenge.git
```
2. Install Deno by visiting the
[Deno installation guide](https://deno.com/manual@v1.34.1/getting_started/installation)
and following the instructions provided.
3. Open your terminal or command prompt and navigate to the project directory:
```bash
cd mindful-chef-challenge
```
4. Run the following command to execute the robot controller, replacing
with the desired sequence of commands:
This command uses Deno
```bash
deno run mod.ts
```
This command uses Ruby
```bash
bundle exec ruby robot_cli.rb
```
_N.B. you may need to run `bundle install` as [Bunlder](https://bundler.io/)
is managing dependencies for Ruby before running the Ruby command_
| Option | Description | Default |
| ----------------- | ---------------------------------------------------------------------------------------------------------------- | ------- |
| `` | Nvigate the robot using compas directions
- `N` = North
- `S` = South
- `E` = East
- `W` = West | |
| `--start=,` | (optional): Sepecify the starting position of the robot | 0,0 |
For example, to navigate the robot to grid position [4,4], use the following
command: ``.
```bash
deno run mod.ts 'N,E,N,E,N,E,N,E'
```
```bash
bundle exec ruby robot_cli.rb 'N,E,N,E,N,E,N,E' --start=4,4
```
5. The result will be the final position of the robot within the warehouse grid.
## 🧪 Testing
To ensure the correctness of the tool, unit tests are provided. Follow the
instructions below to run the tests:
```bash
deno test -A
```
```bash
bundle exec rake test
```
## 🚨 Linting
The warehouse robot controller adheres to coding standards and best practices.
To run the linter and formatter on the codebase, execute the following commands:
- Format the code using Deno's built-in formatter:
```bash
deno fmt
```
- Run the Deno linter to check for potential issues and enforce coding
standards:
```bash
deno lint
```
- Run the Ruby typechecker to check for potential issues and enforce coding
standards:
```bash
bundle exec srb tc
```
The linter checks your code for potential issues, enforces best practices, and
alerts you to any deviations from the recommended coding standards.
## 🎓 License
MIT: https://kylewelsby.mit-license.org