Skip to content

Latest commit

 

History

History
 
 

opentrons-ai-client

Opentrons AI Frontend

JavaScript Style Guide

Overview

The Opentrons AI application helps you to create a protocol with natural language.

Developing

To get started: clone the Opentrons/opentrons repository, set up your computer for development as specified in the contributing guide, and then:

# change into the cloned directory
cd opentrons

# prerequisite: install dependencies as specified in project setup
make setup

# if you have done the setup already, you can run the following instead of make setup
make teardown-js && make setup-js

# launch the dev server
make -C opentrons-ai-client dev

Stack and structure

The UI stack is built using:

Some important directories:

Copy management

We use i18next for copy management and internationalization.

Testing

Tests for the Opentrons App are run from the top level along with all other JS project tests.

  • make test-js - Run all JavaScript tests

Test tasks can also be run with the following arguments:

Argument Default Description Example
watch false Run tests in watch mode make test-unit watch=true
cover !watch Calculate code coverage make test watch=true cover=true

Building

TBD