Skip to content

Commit

Permalink
Add support for Sail development environments (gomods#1248)
Browse files Browse the repository at this point in the history
* initial sail Dockerfile

* host mount the module download cache so it's preserved over restarts

* expose port 3000

* add some basic docs
  • Loading branch information
brainflake authored and arschles committed Aug 5, 2019
1 parent b6bcf0e commit df82bbc
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
7 changes: 7 additions & 0 deletions .sail/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
FROM codercom/ubuntu-dev-go

ENV GO111MODULE=on

LABEL share.go_mod="~/go/pkg/mod:~/go/pkg/mod"

EXPOSE 3000
15 changes: 13 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,13 @@ GO_BINARY_PATH=go1.11.X

# Run the Proxy

We provide two ways to run the proxy on your local machine:
We provide three ways to run the proxy on your local machine:

1. Using [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) (_we suggest this one if you're getting started_)
2. Natively on your host
3. Using [Sail](https://sail.dev)

See below for instructions to do both!
.See below for instructions for each option!

## Using Docker

Expand Down Expand Up @@ -96,6 +97,16 @@ After the server starts, you'll see some console output like:
Starting application at 127.0.0.1:3000
```

## Using Sail

Follow instructions at [sail.dev](https://sail.dev) to setup the sail CLI. Then simply run:

```
sail run gomods/athens
```

The command will automatically clone the athens repo and give you a local URL that you can use to open an editor and development environment directly in your browser.

### Dependencies

# Services that Athens Needs
Expand Down

0 comments on commit df82bbc

Please sign in to comment.