UNPKG

2.94 kBMarkdownView Raw
1# Ember-cli-surge
2
3[![Greenkeeper badge](https://badges.greenkeeper.io/kiwiupover/ember-cli-surge.svg)](https://greenkeeper.io/)
4[![Build Status](https://travis-ci.org/kiwiupover/ember-cli-surge.svg)](https://travis-ci.org/kiwiupover/ember-cli-surge)
5[![Ember Observer Score](http://emberobserver.com/badges/ember-cli-surge.svg)](http://emberobserver.com/addons/ember-cli-surge)
6[![Code Climate](https://codeclimate.com/github/kiwiupover/ember-cli-surge/badges/gpa.svg)](https://codeclimate.com/github/kiwiupover/ember-cli-surge)
7[![npm version](https://badge.fury.io/js/ember-cli-surge.svg)](https://badge.fury.io/js/ember-cli-surge)
8[![](https://david-dm.org/kiwiupover/ember-cli-surge.svg)](https://david-dm.org/kiwiupover/ember-cli-surge.svg)
9
10## Static Web Publishing for Front-End Developers
11[surge.sh](http://surge.sh) Zero-bullshit, single–command,
12bring your own source control web publishing CDN. Yes, it's free.
13[Surge Docs](http://surge.sh/help)
14
15
16## Installation
17```sh
18ember install ember-cli-surge
19```
20
21## Deployment
22
23```sh
24ember surge
25```
26
27The above command will build your ember app using the production environment then deploy that code to the url `<your-project-name>.surge.sh`
28
29By passing an environment flag `ember surge --environment development` to the ember surge command will use your development environment.
30
31The default domain name for your project is the `<your-app-name.surge.sh>`. This can be found in the `CNAME` file at the root of your project.
32Use `ember generate surge-domain <your-new-domain>` to update the domain which will update the `CNAME` file. Remember the domain name needs to be unique.
33
34For more info check out [Surge Docs](http://surge.sh/help/remembering-a-domain)
35
36### Other commands
37- `ember surge --new-domain` Add your own domain name ie: `--new-domain="kiwis-are-great.surge.sh"` or (surge.sh) will generate a domain when no argument is passed in ie:`--new-domain`
38 - alias: `-d`
39- `ember surge --login` Login to your account at Surge (surge.sh).
40 - alias: `-l`
41- `ember surge --whoami` Check who you are logged in as.
42 - alias: `-w`
43- `ember surge --publish` (Default: true) Publishes a project to the web using Surge (surge.sh).
44 - alias: `-p`
45- `ember surge --list` List all the projects you’ve published on Surge (surge.sh).
46 - alias: `-ls`
47- `ember surge --token` Get surge.sh authentication token, great for Continuous Integration (CI).
48 - alias: `-t`
49- `ember surge --environment` (Default: production) The ember env you want deployed default (production).
50 - alias: `-e`
51- `ember surge --logout` Log out of your account at Surge (surge.sh).
52- `ember surge --teardown` Tear down a published project.
53 - alias: `-td`
54
55## Contributing
56We would love to hear your feedback and welcome your PRs.
57Cheers.
58
59### Running Tests
60
61* `yarn test`
62
63* `npm run lint:js`
64* `npm run lint:js -- --fix`
65
66## License
67This software is distributed under the MIT license.