Files

Quentin McGaw 68203c221d Refactored documentation for Docker hub workflow

- Readme size lowered to 18KB
- Documents created in doc/ directory
- faq.md, firewall.md, development.md
- Title svg as absolute path for Docker hub
- Re-enabled Docker hub description workflow

2020-04-12 13:42:41 +00:00

1.5 KiB

Raw Blame History

Development

Setup

Using VSCode and Docker

That should be easier and better than a local setup, although it might use more memory if you're not on Linux.

Install Docker
- On Windows, share a drive with Docker Desktop and have the project on that partition
- On OSX, share your project directory with Docker Desktop
With Visual Studio Code, install the remote containers extension
In Visual Studio Code, press on F1 and select Remote-Containers: Open Folder in Container...
Your dev environment is ready to go!... and it's running in a container 👍

Locally

Install Go, Docker and Git; then:

go mod download

And finally install golangci-lint

Commands available

# Build the entrypoint binary
go build cmd/main.go
# Test the entrypoint code
go test ./...
# Lint the code
golangci-lint run
# Build the Docker image
docker build -t qmcgaw/private-internet-access .

Guidelines

The Go code is in the Go file cmd/main.go and the internal directory, you might want to start reading the main.go file.

See the Contributing document for more information on how to contribute to this repository.

1.5 KiB Raw Blame History