|
1 | | -# smoke-test-app |
| 1 | +smoke-test-app |
| 2 | +============================================================================== |
2 | 3 |
|
3 | | -This README outlines the details of collaborating on this Ember application. |
4 | | -A short introduction of this app could easily go here. |
| 4 | +[Short description of the addon.] |
5 | 5 |
|
6 | | -## Prerequisites |
7 | 6 |
|
8 | | -You will need the following things properly installed on your computer. |
| 7 | +Compatibility |
| 8 | +------------------------------------------------------------------------------ |
9 | 9 |
|
10 | | -* [Git](https://git-scm.com/) |
11 | | -* [Node.js](https://nodejs.org/) |
12 | | -* [Yarn](https://yarnpkg.com/) |
13 | | -* [Ember CLI](https://ember-cli.com/) |
14 | | -* [Google Chrome](https://google.com/chrome/) |
| 10 | +* Ember.js v3.24 or above |
| 11 | +* Ember CLI v3.24 or above |
| 12 | +* Node.js v12 or above |
15 | 13 |
|
16 | | -## Installation |
17 | 14 |
|
18 | | -* `git clone <repository-url>` this repository |
19 | | -* `cd smoke-test-app` |
20 | | -* `yarn install` |
| 15 | +Installation |
| 16 | +------------------------------------------------------------------------------ |
21 | 17 |
|
22 | | -## Running / Development |
| 18 | +``` |
| 19 | +ember install smoke-test-app |
| 20 | +``` |
23 | 21 |
|
24 | | -* `ember serve` |
25 | | -* Visit your app at [http://localhost:4200](http://localhost:4200). |
26 | | -* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). |
27 | 22 |
|
28 | | -### Code Generators |
| 23 | +Usage |
| 24 | +------------------------------------------------------------------------------ |
29 | 25 |
|
30 | | -Make use of the many generators for code, try `ember help generate` for more details |
| 26 | +[Longer description of how to use the addon in apps.] |
31 | 27 |
|
32 | | -### Running Tests |
33 | 28 |
|
34 | | -* `ember test` |
35 | | -* `ember test --server` |
| 29 | +Contributing |
| 30 | +------------------------------------------------------------------------------ |
36 | 31 |
|
37 | | -### Linting |
| 32 | +See the [Contributing](CONTRIBUTING.md) guide for details. |
38 | 33 |
|
39 | | -* `npm run lint:hbs` |
40 | | -* `npm run lint:js` |
41 | | -* `npm run lint:js -- --fix` |
42 | 34 |
|
43 | | -### Building |
| 35 | +License |
| 36 | +------------------------------------------------------------------------------ |
44 | 37 |
|
45 | | -* `ember build` (development) |
46 | | -* `ember build --environment production` (production) |
47 | | - |
48 | | -### Deploying |
49 | | - |
50 | | -Specify what it takes to deploy your app. |
51 | | - |
52 | | -## Further Reading / Useful Links |
53 | | - |
54 | | -* [ember.js](https://emberjs.com/) |
55 | | -* [ember-cli](https://ember-cli.com/) |
56 | | -* Development Browser Extensions |
57 | | - * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) |
58 | | - * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) |
| 38 | +This project is licensed under the [MIT License](LICENSE.md). |
0 commit comments