kasperisager / rover

:rocket: Exploring images from the Perseverance rover on the web and command line

Rover / Exports

Rover

🚀 Exploring images from the Perseverance rover on the web and command line

Table of contents

• Building
• Usage

Building

To build the project, make sure to first install a recent version of Node.js and the Yarn package manager. Once installed, fetch the needed dependencies:

yarn install

Next, build the project:

yarn build

To run the set suite, do:

yarn test

Usage

The project has two available front ends: A web application and a command line interface. For programmatic usage, check out the shared @rover/lib module.

Web application

To use the web application, do:

yarn workspace @rover/app start

The web application exposes 3 endpoints:

1. /
   Show a carousel of rover images. The transition speed can be adjusted via the speed query parameter.

2. /latest
   Show the latest rover image.

3. /:index
   Show the specified rover image.

Command line

To use the command line interface, do:

yarn workspace @rover/cli rover

The command line interface exposes 3 commands:

1. get-all
   Show a carousel of rover images. The transition speed can be adjusted via the --speed flag.

2. get-latest
   Show the latest rover image.

3. get <index>
   Show the specified rover image.