Initial commit

Author: kennethormandy

.gitignore

@@ -0,0 +1,17 @@
+# OS
+.DS_Store
+
+# Logs
+logs
+*.log*
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+node_modules
+components
+bower_components
+
+# Compile directories
+www/

LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright © 2015 [Chloi Inc.](https://chloi.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,124 @@
+# CircleCI example [![CircleCI Status for surge-sh/example-circleci](https://circleci.com/projects/86b9dbb0-eb83-0132-4c31-26192dc48311/status?branch=master)](https://circleci.com/projects/83463)
+
+An example using [CircleCI](https://circleci.com) for continuous deployment to [Surge.sh](https://surge.sh).
+
+## Getting started
+
+Continuous Deployment services like [CircleCI](https://circleci.com) make it possible to run publish your project on Surge each time you push to a GitHub repository.
+
+This guide will walk you through:
+
+1. Getting your Surge token, so CircleCI can login to Surge on your behalf
+2. Adding Surge as a `devDependency`, so CircleCI can install Surge
+3. Setting up your project on CircleCI, so you can publish each time you push to GitHub
+
+First, you’ll need your token from the Surge CLI. This secret key lets services like CircleCI login and publish projects on your behalf. Get your Surge token by running the following command in your terminal:
+
+```
+surge token
+```
+
+You’ll be asked to login again, and afterwards your token will be displayed like this:
+
+```
+token: a142e09a6b13a21be512b141241c7123
+```
+
+![Getting your token from the Surge CLI.](https://surge.sh/images/help/integrating-with-circleci.gif)
+
+### Adding Surge as a `devDependency` to a `package.json` file
+
+CircleCI’s machines won’t have Surge installed by default, so you also need to save Surge as a development dependency in your project. This lets CircleCI know it needs to install Surge to publish your project.
+
+You can do this by creating a `package.json` file if you don’t have one already. Run the following command in your terminal to be walked through making this file (you can hit enter to accept the defaults):
+
+```sh
+npm init
+```
+
+You will end up with a file that looks [something like this one](package.json).
+
+Next, run this command to save Surge as a `devDependency`, so CircleCI will install it:
+
+```sh
+npm install --save-dev surge
+```
+
+<!--
+
+### Add your project’s repository to CircleCI
+
+Now you can login and setup a new project on CircleCI. Add your project’s GitHub repository to your CircleCI projects:
+
+![Add the GitHub repository your project is stored in. This example is using the surge-sh/example-circleci repo.](https://surge.sh/images/help/integrating-with-circleci-2.png)
+
+### Define your Setup and Test Commands
+
+Now you’re ready to run `surge` on CircleCI. Your CircleCI setup commands run before the deployment command.
+
+![](https://surge.sh/images/help/integrating-with-circleci-3.png)
+
+Your setup commands should look like this:
+
+```sh
+# Install the latest version of Node.js
+nvm install stable
+nvm use stable
+
+# Install Surge as a devDependency
+npm install
+```
+
+After you push you successfully to your repository, CircleCI will run your Test Pipeline commands, which is when you can publish your project with Surge:
+
+```sh
+# Run your tests (if you have any)
+npm test
+
+# Run Surge
+surge --project ./ --domain example-circleci.surge.sh
+```
+
+### Add Environment Variables
+
+Press _Environment Variables_ next, and you’ll be able to secretly add your email address and token so CircleCI can login to Surge for you:
+
+![Environment Variables is listed under your project settings.](https://surge.sh/images/help/integrating-with-circleci-4.png)
+
+Create one environment variable called:
+
+```
+SURGE_LOGIN
+```
+
+…and set it to the email address you use with Surge. Next, add another environment variable called:
+
+```
+SURGE_TOKEN
+```
+
+…and set it to your Surge token.
+
+![Adding `SURGE_LOGIN` and `SURGE_TOKEN` as environment variables.](https://surge.sh/images/help/integrating-with-circleci-5.png)
+
+### Add a deployment script
+
+Push to your repository, and your Setup and Test commands should run, triggering your tests to run on CircleCI. Now, CircleCI will let you move onto adding a script for Continuous Deployment. You can press the button labeled _Set up Continuous Deployment_ or access this section under your project settings:
+
+![Adding a custom script for continuous deployment.](https://surge.sh/images/help/integrating-with-circleci-6.png)
+
+Add a _Custom Script_ and enter the command you want to run with Surge, for example:
+
+```sh
+surge --project ./ example-circleci.surge.sh
+```
+
+Now, when you push your project to GitHub again, this command will be run and your project will get published automatically.
+
+-->
+
+## License
+
+[The MIT License (MIT)](LICENSE.md)
+
+Copyright © 2015 [Chloi Inc.](http://chloi.io)

index.html

@@ -0,0 +1 @@
+<h1>Hello, world</h1>

package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@surge/example-circleci",
+  "version": "0.1.0",
+  "description": "An example using CircleCI for continuous deployment to Surge.",
+  "homepage": "https://surge.sh",
+  "repository": "https://github.com/surge-sh/example-circleci.git",
+  "license": "MIT",
+  "private": true,
+  "author": "Kenneth Ormandy <[email protected]> (http://kennethormandy.com)",
+  "contributors": [
+    "Kenneth Ormandy <[email protected]> (http://kennethormandy.com)",
+    "Brock Whitten   <[email protected]>   (http://sintaxi.com)"
+  ],
+  "keywords": ["surge", "surge.sh", "example", "circleci", "static"],
+  "devDependencies": {
+    "mocha": "2.2.5",
+    "surge": "latest"
+  },
+  "scripts": {
+    "test": "./node_modules/.bin/mocha",
+    "compile": "echo \"If you’re using a static site generator or other compilation step, you could run it here!\"",
+    "deploy": "npm run compile && surge --project ./ --domain example-circleci.surge.sh"
+  }
+}