https://github.com/calbertts/martian-robots

https://github.com/calbertts/martian-robots

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/calbertts/martian-robots
• Owner: calbertts
• Created: 2020-10-24T15:36:55.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-11-03T14:19:34.000Z (over 5 years ago)
• Last Synced: 2026-06-09T07:35:25.775Z (about 2 months ago)
• Language: JavaScript
• Homepage: https://calbertts-martian-robots.herokuapp.com/
• Size: 522 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Martian Robots

[![Test Coverage](https://api.codeclimate.com/v1/badges/e88967b069c4f01dece8/test_coverage)](https://codeclimate.com/github/calbertts/martian-robots/test_coverage)

Technical test for GuidSmiths

There's a core and two interfaces (CLI and Web).

## Architecture overview

![martian-robots-arch](martian-robots-arch.png)

## How to run as CLI tool

### Interactive input

```

docker run --rm -it calbertts/martian-robots:v1

```

### With an input file

```

echo "5 3

1 1 E

RFRFRFRF

3 2 N

FRRFLLFFRRFLL

0 3 W

LLFFFLFLFL" > inputFile

docker run -i --rm calbertts/martian-robots:v1 < inputFile 

```

### Showing more execution details

```

docker run -i --rm -e DETAILED="true" calbertts/martian-robots:v1 < inputFile 

```

### With an input file in a pipeline

```

cat inputFile | docker run -i --rm calbertts/martian-robots:v1

```

## How to run as a web server with an UI locally

```

node app/src/interfaces/server.js

```

A public demo can be checkout here:

https://calbertts-martian-robots.herokuapp.com/

![martian-robots-animation](martian-robots.gif)

## How to build the Docker image

```

npm run build-docker-image

```