Refactored project layout (fix: #109) (#111)

* Reworked project layout

* adjusted Makefile for new folder structure

* fixed path errors

* Fixed test import paths

* fixes

* only pushing image to the docker hub if the branch is master

Author: mxschmitt

.gitignore

@@ -19,9 +19,8 @@ debug.test
 *.db
 *.lock
 /config.*
-/handlers/static.go
-/handlers/tmpls/tmpls.go
-/store/main.db
+/internal/handlers/static.go
+/internal/handlers/tmpls/tmpls.go
 /releases
-/data
-docker_releases/
+/docker_releases
+data

.travis.yml

@@ -11,9 +11,9 @@ install:
   - npm install
 script:
   - make
-  - goveralls -service=travis-ci -ignore="handlers/static.go,handlers/tmpls/tmpls.go"
+  - goveralls -service=travis-ci -ignore="internal/handlers/static.go,internal/handlers/tmpls/tmpls.go"
   - make buildDockerImage 
-  - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then docker login -u "$DOCKER_USERNAME" -p "$DOCKER_PASSWORD" && docker push mxschmitt/golang_url_shortener && docker push mxschmitt/golang_url_shortener:arm; fi'
+  - 'if [[ "$TRAVIS_PULL_REQUEST" = "false" && "$TRAVIS_BRANCH" = "master" ]]; then docker login -u "$DOCKER_USERNAME" -p "$DOCKER_PASSWORD" && docker push mxschmitt/golang_url_shortener && docker push mxschmitt/golang_url_shortener:arm; fi'
 deploy:
   provider: bintray
   user: mxschmitt

Makefile

@@ -4,13 +4,13 @@ runUnitTests:
 	go test -v ./...
 
 buildNodeFrontend:
-	cd static && yarn install
-	cd static && yarn build
-	cd static && rm build/static/**/*.map
+	cd web && yarn install
+	cd web && yarn build
+	cd web && rm build/static/**/*.map
 
 embedFrontend:
-	cd handlers/tmpls && esc -o tmpls.go -pkg tmpls -include ^*\.html .
-	cd handlers && esc -o static.go -pkg handlers -prefix ../static/build ../static/build
+	cd internal/handlers/tmpls && esc -o tmpls.go -pkg tmpls -include ^*\.html .
+	cd internal/handlers && esc -o static.go -pkg handlers -prefix ../../web/build ../../web/build
 
 getCMDDependencies:
 	go get -v github.com/mattn/goveralls
@@ -23,13 +23,13 @@ getGoDependencies:
 buildProject:
 	rm -rf releases 
 	mkdir releases
-	gox -output="releases/{{.Dir}}_{{.OS}}_{{.Arch}}/{{.Dir}}" -osarch="linux/amd64 linux/arm windows/amd64 windows/386" -ldflags="-X github.com/mxschmitt/golang-url-shortener/util.ldFlagNodeJS=`node --version` -X github.com/mxschmitt/golang-url-shortener/util.ldFlagCommit=`git rev-parse HEAD` -X github.com/mxschmitt/golang-url-shortener/util.ldFlagYarn=`yarn --version` -X github.com/mxschmitt/golang-url-shortener/util.ldFlagCompilationTime=`TZ=UTC date +%Y-%m-%dT%H:%M:%S+0000`"
-	find releases -maxdepth 1 -mindepth 1 -type d -exec cp build/config.yaml {} \;
+	gox -output="releases/{{.Dir}}_{{.OS}}_{{.Arch}}/{{.Dir}}" -osarch="linux/amd64 linux/arm windows/amd64 windows/386" -ldflags="-X github.com/mxschmitt/golang-url-shortener/internal/util.ldFlagNodeJS=`node --version` -X github.com/mxschmitt/golang-url-shortener/internal/util.ldFlagCommit=`git rev-parse HEAD` -X github.com/mxschmitt/golang-url-shortener/internal/util.ldFlagYarn=`yarn --version` -X github.com/mxschmitt/golang-url-shortener/internal/util.ldFlagCompilationTime=`TZ=UTC date +%Y-%m-%dT%H:%M:%S+0000`" ./cmd/golang-url-shortener
+	find releases -maxdepth 1 -mindepth 1 -type d -exec cp config/example.yaml {} \;
 	find releases -maxdepth 1 -mindepth 1 -type d -exec tar -cvjf {}.tar.bz2 {} \;
 
 buildDockerImage:
 	rm -rf docker_releases 
 	mkdir docker_releases
-	CGO_ENABLED=0 gox -output="docker_releases/{{.Dir}}_{{.OS}}_{{.Arch}}/{{.Dir}}" -osarch="linux/amd64 linux/arm" -ldflags="-X github.com/mxschmitt/golang-url-shortener/util.ldFlagNodeJS=`node --version` -X github.com/mxschmitt/golang-url-shortener/util.ldFlagCommit=`git rev-parse HEAD` -X github.com/mxschmitt/golang-url-shortener/util.ldFlagYarn=`yarn --version` -X github.com/mxschmitt/golang-url-shortener/util.ldFlagCompilationTime=`TZ=UTC date +%Y-%m-%dT%H:%M:%S+0000`"
-	docker build -t mxschmitt/golang_url_shortener:arm -f Dockerfile.arm .
-	docker build -t mxschmitt/golang_url_shortener -f Dockerfile.amd64 .
+	CGO_ENABLED=0 gox -output="docker_releases/{{.Dir}}_{{.OS}}_{{.Arch}}/{{.Dir}}" -osarch="linux/amd64 linux/arm" -ldflags="-X github.com/mxschmitt/golang-url-shortener/internal/util.ldFlagNodeJS=`node --version` -X github.com/mxschmitt/golang-url-shortener/internal/util.ldFlagCommit=`git rev-parse HEAD` -X github.com/mxschmitt/golang-url-shortener/internal/util.ldFlagYarn=`yarn --version` -X github.com/mxschmitt/golang-url-shortener/internal/util.ldFlagCompilationTime=`TZ=UTC date +%Y-%m-%dT%H:%M:%S+0000`" ./cmd/golang-url-shortener
+	docker build -t mxschmitt/golang_url_shortener:arm -f build/Dockerfile.arm .
+	docker build -t mxschmitt/golang_url_shortener -f build/Dockerfile.amd64 .

Dockerfile.amd64 renamed to build/Dockerfile.amd64

@@ -4,9 +4,9 @@ import (
 	"os"
 	"os/signal"
 
-	"github.com/mxschmitt/golang-url-shortener/handlers"
-	"github.com/mxschmitt/golang-url-shortener/stores"
-	"github.com/mxschmitt/golang-url-shortener/util"
+	"github.com/mxschmitt/golang-url-shortener/internal/handlers"
+	"github.com/mxschmitt/golang-url-shortener/internal/stores"
+	"github.com/mxschmitt/golang-url-shortener/internal/util"
 	"github.com/pkg/errors"
 	"github.com/shiena/ansicolor"
 	"github.com/sirupsen/logrus"

Dockerfile.arm renamed to build/Dockerfile.arm

@@ -6,7 +6,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/mxschmitt/golang-url-shortener/util"
+	"github.com/mxschmitt/golang-url-shortener/internal/util"
 )
 
 func TestInitShortener(t *testing.T) {

main.go renamed to cmd/golang-url-shortener/main.go

@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"net/http"
 
-	"github.com/mxschmitt/golang-url-shortener/handlers/auth"
-	"github.com/mxschmitt/golang-url-shortener/util"
+	"github.com/mxschmitt/golang-url-shortener/internal/handlers/auth"
+	"github.com/mxschmitt/golang-url-shortener/internal/util"
 	"github.com/sirupsen/logrus"
 
 	jwt "github.com/dgrijalva/jwt-go"