@starbird/template v1.0.4

Welcome to your |-module-| module

A MYOB Starbird powered module.

npm install -g @starbird/cli

Starbird Documentation

Usage

This module is React based and contains a ready to use test pipeline build on top of Jest and Storybook as a convenient component sandbox.

• starbird start -> Runs the project in watch mode for development running with the node server for STS authentication
• starbird build -> Builds the project for deployment
• starbird test -> Runs the project's tests
• starbird coverage -> Runs the project's tests and write a code coverage report
• starbird lint -> Runs the linter on the code to detect issues with code style
• starbird deploy -> Deploys the project on a server
• starbird storybook -> Runs the project 'stories' you might have created
• starbird update -> Update the Starbird SDK and tooling
• starbird feedback -> Opens a feedback form with the default browser
• starbird issues -> Opens the github starbird issues page

Integrated development with Shell NOVA

You can either run the project in watch mode for local development using starbird start or implement an integrated version of your module with the Shell nova.

Configuration

Several configuration files are available:

• src/config.json provides an opportunity to set and inject any custom settings you might need to run your deployed module
• src/local.json local settings and mocks global variables that are available in the deployed app running the Shell (Practice Online app)

Testing

A pipeline to run tests built on top of Jest is available. By default starbird test will run the tests it finds inside your src folder and keeps watching for any new tests added or tested updated and run those. It is then possible to always have a terminal open with Jest watching your tests and another terminal to run your module locally.

Note: If you want to turn on coverage for your tests, define thresholds or further configure Jest, you can edit your package.json file by using the information found on this page. For convenience this project has a Jest setup file pre-filled that you can further modify and fins in src/jest.setup.js.

Documentation and support

• Changelog found in CHANGELOG.Starbird.md
• Open issues
• Wiki

Recommendations

Working on a Linux or MacOS machine offer the best experience as they have unix-type shells.
If you use Windows, we recommend you use Windows 10 and install and use a bash environment. Windows has now the ability to run Linux distributions inside of Windows and you can take advantage of this.
Microsoft officially supports a Windows Subsystem for Linux in Windows 10. Read more about it here.

The boilerplate comes with ESlint, Prettier and Babel support. To make the best use of those and/or setup an environment for the free Visual Studio Code editor, you can follow the information and instructions in this web page.

By default the code style, structure and common bugs squashing are enforced by eslint using the strict AirBnb rules and prettier. You can learn more about AirBnb by reading their Javascript and React guides here

Mentions

This boilerplate project, its sandbox environment and SDK is brought to you by the Rogue Squadron team at MYOB.