ember-cli/ember-cli

View on GitHub
blueprints/app/files/README.md

Summary

Maintainability
Test Coverage
# <%= name %>

This README outlines the details of collaborating on this Ember application.
A short introduction of this app could easily go here.

## Prerequisites

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

- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/)<% if (pnpm) { %>
- [pnpm](https://pnpm.io/)<% } else if (yarn) { %>
- [Yarn](https://yarnpkg.com/)<% } else { %> (with npm)<% } %>
- [Ember CLI](https://cli.emberjs.com/release/)
- [Google Chrome](https://google.com/chrome/)

## Installation

- `git clone <repository-url>` this repository
- `cd <%= appDirectory %>`
- `<% if (pnpm) { %>pnpm<% } else if (yarn) { %>yarn<% } else { %>npm<% } %> install`

## Running / Development

- `<%= invokeScriptPrefix %> start`
- Visit your app at [http://localhost:4200](http://localhost:4200).
- Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).

### Code Generators

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

### Running Tests

- `<%= invokeScriptPrefix %> test`
- `<%= invokeScriptPrefix %> test:ember <% if (npm) { %>-- <% } %>--server`

### Linting

- `<%= invokeScriptPrefix %> lint`
- `<%= invokeScriptPrefix %> lint:fix`

### Building

- `<%= execBinPrefix %> ember build` (development)
- `<%= invokeScriptPrefix %> build` (production)

### Deploying

Specify what it takes to deploy your app.

## Further Reading / Useful Links

- [ember.js](https://emberjs.com/)
- [ember-cli](https://cli.emberjs.com/release/)
- 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/)