threshold-ui/addons/rose/README.md

Rose - Style & Component Ember Addon for Project Watchtower

This addon contains common styles and components shared by Project Watchtower UIs.

Table of Contents generated with DocToc

• Add Styles to an App
• Installation
• Yarn Commands
• Linting
• Formatting
• Building Components
• Running tests
• Running the dummy application
• Contributing
  • Building ToC

Add Styles to an App

Add this addon to an Ember application's devDependencies as: "rose": "*", for applications included in this monorepo. Application's may then import rose styles by adding @import 'rose'; to their stylesheets.

Installation

See monorepo README for installation instructions.

Yarn Commands

List of available project commands. yarn run <command-name>

Command	Description
build	Builds the dummy app in development mode.
build:production	Builds the dummy app for production.
lint	Runs all lint commands.
lint:hbs	Lints template hbs files.
lint:js	Lints js files.
lint:sass	Lints scss files.
format	Runs all auto-formatters.
format:js	Auto-formats js files using Prettier.
format:sass	Auto-formats scss files using Prettier.
start	Runs the dummy app local server.
storybook	Runs the Storybook local server on port 6006. Be sure to start the standard server (see above) in a separate terminal.
test	Runs all tests.
test:all	Runs tests across multiple Ember versions with ember-try.
doc:toc	Automatically generates a table of contents for this README file.

Additional commands in the monorepo package may affect this projects.

Linting

• yarn lint:hbs
• yarn lint:js
• yarn lint:js --fix

Formatting

Before submitting your work, be sure to run auto-formatters (see commands above). This helps to ensure consistency among authors.

• yarn format

Building Components

To build a new component, start by generating it on the command line with ember g component rose/component-name. Then manually add a Storybook story in stories/component-name.stories.js. Use the Storybook UI during component development (see Yarn commands).

Running tests

• yarn test – Runs the test suite on the current Ember version
• yarn test --server – Runs the test suite in "watch mode"
• yarn test:all – Runs the test suite against multiple Ember versions

Running the dummy application

• yarn start
• Visit the dummy application at http://localhost:4200.

Contributing

See monorepo README for more contribution instructions.

Building ToC

To autogenerate a ToC (table of contents) for this README, run yarn doc:toc. Please update the ToC whenever editing the structure of README.