https://github.com/melsumner/design-system-docs-prototype

https://github.com/melsumner/design-system-docs-prototype

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/melsumner/design-system-docs-prototype
• Owner: MelSumner
• Created: 2021-09-07T17:51:09.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-07T22:22:32.000Z (over 3 years ago)
• Last Synced: 2024-10-03T12:26:53.864Z (3 months ago)
• Language: JavaScript
• Size: 619 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://git-scm.com/)

* [Node.js](https://nodejs.org/)

* [Yarn](https://yarnpkg.com/)

* [Ember CLI](https://ember-cli.com/)

* [Google Chrome](https://google.com/chrome/)

## Installation

* `git clone ` this repository

* `cd design-system-docs-prototype`

* `yarn install`

## Running / Development

* `ember serve`

* Visit your app at [http://localhost:4200](http://localhost:4200).

* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).

### Ember Addons Used

* [ember-a11y-refocus](https://github.com/ember-a11y/ember-a11y-refocus) for accessible routing

* [ember-composable-helpers](https://github.com/DockYard/ember-composable-helpers)

* [ember-truth-helpers](https://github.com/jmurphyau/ember-truth-helpers)

* [Adding Tailwind CSS](https://gist.github.com/Robert-96/4d85dcafe05d9e5e72d813ae7107cc47)

* [broccoli-static-site-json](https://github.com/empress/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](https://emberjs.com/)

* [ember-cli](https://ember-cli.com/)

* Development Browser Extensions

  * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)

  * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)