design-system-docs-prototype

This doesn't work right now, it exists in order to troubleshoot it.

Prerequisites

You will need the following things properly installed on your computer.

• Git
• Node.js
• Yarn
• Ember CLI
• Google Chrome

Installation

• git clone <repository-url> this repository
• cd design-system-docs-prototype
• yarn install

Running / Development

• ember serve
• Visit your app at http://localhost:4200.
• Visit your tests at http://localhost:4200/tests.

Ember Addons Used

• ember-a11y-refocus for accessible routing
• ember-composable-helpers
• ember-truth-helpers
• Adding Tailwind CSS
• broccoli-static-site-json

Adding Documentation

• in the docs folder, create a new .md file, using existing files in that folder for naming and content formatting (including frontmatter).
• need a new tag? Add a new .md file in the tags folder.

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests

• ember test
• ember test --server

Linting

• yarn lint
• yarn lint:fix

Building

• ember build (development)
• ember build --environment production (production)

Deploying

Specify what it takes to deploy your app.

Further Reading / Useful Links

• ember.js
• ember-cli
• Development Browser Extensions
  • ember inspector for chrome
  • ember inspector for firefox