refactor local development path, experiement with different logging

Author: adamdevigili

.env

@@ -0,0 +1,29 @@
+# API
+PORT=8080
+TOKEN_KEY=
+#DEV_MODE=true
+
+# DB
+#DB_DISABLED=true
+DB_HOST=db
+DB_PORT=5432
+DB_USER=postgres
+DB_PASSWORD=
+DB_DATABASE=skillbased
+DB_DEFAULT=postgres
+
+# FRONTEND
+AUTH0_SECRET=
+AUTH0_BASE_URL=
+AUTH0_ISSUER_BASE_URL=
+AUTH0_CLIENT_ID=
+AUTH0_CLIENT_SECRET=
+AUTH0_AUDIENCE=
+AUTH0_SCOPE=
+
+SKILLBASED_API_HOST=http://localhost:8080
+SKILLBASED_API_VERSION=v1
+SKILLBASED_API=$SKILLBASED_API_HOST/$SKILLBASED_API_VERSION
+
+# NGINX
+HOSTNAME=

README.md

@@ -3,7 +3,12 @@
 
 [skillbased](http://skillbased.xyz) is a service that is aimed to provide players of casual, "pick-up" type sports to quickly and easily create balanced teams for their activity, and save those teams to create elevated levels of competition.
 
-Deploy locally with: `docker-compose -f docker-compose.yml up --build`
+## Development
+
+Rename the `.env` file to `.env.local`. The default values should allow the API and postgres to start, however to
+enable Auth0 on the frontend, you'll need to supply your own credentials to their corresponding environment variables
+
+Build and run the API, frontend, and a postgres database locally with: `docker-compose -f docker-compose.local.yml up --build`
 
 ## Tech
 ### Stack

api/.env

@@ -5,7 +5,7 @@ TOKEN_KEY=
 
 # DB
 #DB_DISABLED=true
-DB_HOST=
+DB_HOST=test
 DB_PORT=
 DB_USER=
 DB_PASSWORD=

api/go.mod

@@ -3,30 +3,32 @@ module github.com/adamdevigili/skillbased/api
 go 1.17
 
 require (
-	github.com/auth0/go-jwt-middleware v1.0.1-0.20210719135851-6401fcf7191b
 	github.com/badoux/checkmail v1.2.1
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible
-	github.com/golang-jwt/jwt v3.2.2+incompatible
 	github.com/google/uuid v1.3.0
 	github.com/jinzhu/gorm v1.9.16
 	github.com/joho/godotenv v1.4.0
 	github.com/kelseyhightower/envconfig v1.4.0
 	github.com/labstack/echo/v4 v4.6.1
 	github.com/labstack/gommon v0.3.0
 	github.com/lib/pq v1.10.3
-	github.com/rs/xid v1.3.0
-	golang.org/x/crypto v0.0.0-20210921155107-089bfa567519
 	github.com/pioz/faker v1.7.2
+	github.com/segmentio/ksuid v1.0.4
+	golang.org/x/crypto v0.0.0-20210921155107-089bfa567519
 )
 
 require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/mattn/go-colorable v0.1.8 // indirect
 	github.com/mattn/go-isatty v0.0.14 // indirect
+	github.com/stretchr/testify v1.7.0 // indirect
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
 	github.com/valyala/fasttemplate v1.2.1 // indirect
 	golang.org/x/net v0.0.0-20210913180222-943fd674d43e // indirect
 	golang.org/x/sys v0.0.0-20210910150752-751e447fb3d0 // indirect
 	golang.org/x/text v0.3.7 // indirect
 	golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 // indirect
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 )

api/go.sum

@@ -1,10 +1,10 @@
 github.com/PuerkitoBio/goquery v1.5.1/go.mod h1:GsLWisAFVj4WgDibEWF4pvYnkVQBpKBKeU+7zCJoLcc=
 github.com/andybalholm/cascadia v1.1.0/go.mod h1:GsXiBklL0woXo1j/WYWtSYYC4ouU9PqHO0sqidkEA4Y=
-github.com/auth0/go-jwt-middleware v1.0.1-0.20210719135851-6401fcf7191b/go.mod h1:Tlhz43qRKMMQ4WAii9sfAuW8sPuAgQCB4yIjPgT8AH0=
 github.com/badoux/checkmail v1.2.1 h1:TzwYx5pnsV6anJweMx2auXdekBwGr/yt1GgalIx9nBQ=
 github.com/badoux/checkmail v1.2.1/go.mod h1:XroCOBU5zzZJcLvgwU15I+2xXyCdTWXyR9MGfRhBYy0=
-github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/denisenkom/go-mssqldb v0.0.0-20191124224453-732737034ffd h1:83Wprp6ROGeiHFAP8WJdI2RoxALQYgdllERc3N5N2DM=
 github.com/denisenkom/go-mssqldb v0.0.0-20191124224453-732737034ffd/go.mod h1:xbL0rPBG9cCiLr28tMa8zpbdarY27NDyej4t/EjAShU=
 github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM=
@@ -13,12 +13,10 @@ github.com/erikstmartin/go-testdb v0.0.0-20160219214506-8d10e4a1bae5 h1:Yzb9+7DP
 github.com/erikstmartin/go-testdb v0.0.0-20160219214506-8d10e4a1bae5/go.mod h1:a2zkGnVExMxdzMo3M0Hi/3sEU+cWnZpSni0O6/Yb/P0=
 github.com/go-sql-driver/mysql v1.5.0 h1:ozyZYNQW3x3HtqT1jira07DN2PArx2v7/mN66gGcHOs=
 github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=
-github.com/golang-jwt/jwt v3.2.1+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
 github.com/golang-jwt/jwt v3.2.2+incompatible h1:IfV12K8xAKAnZqdXVzCZ+TOjboZ2keLg81eXfW3O+oY=
 github.com/golang-jwt/jwt v3.2.2+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
 github.com/golang-sql/civil v0.0.0-20190719163853-cb61b32ac6fe h1:lXe2qZdvpiX5WZkZR4hgp4KJVfY3nMkvmwbVkpv1rVY=
 github.com/golang-sql/civil v0.0.0-20190719163853-cb61b32ac6fe/go.mod h1:8vg3r2VgvsThLBIFL93Qb5yWzgyZWhEmBwUJWevAkK0=
-github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/jinzhu/gorm v1.9.16 h1:+IyIjPEABKRpsu/F8OvDPy9fyQlgsg2luMV2ZIH5i5o=
@@ -50,15 +48,14 @@ github.com/mattn/go-sqlite3 v1.14.0 h1:mLyGNKR8+Vv9CAU7PphKa2hkEqxxhn8i32J6FPj1/
 github.com/mattn/go-sqlite3 v1.14.0/go.mod h1:JIl7NbARA7phWnGvh0LKTyg7S9BA+6gx71ShQilpsus=
 github.com/pioz/faker v1.7.2 h1:fterUcYCbMJ4TgFN8DSqhlwkgbSn9DfsQM1cadbPPw0=
 github.com/pioz/faker v1.7.2/go.mod h1:xSpay5w/oz1a6+ww0M3vfpe40pSIykeUPeWEc3TvVlc=
-github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/rs/xid v1.3.0 h1:6NjYksEUlhurdVehpc7S7dk6DAmcKv8V9gG0FsVN2U4=
-github.com/rs/xid v1.3.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
+github.com/segmentio/ksuid v1.0.4 h1:sBo2BdShXjmcugAMwjugoGUdUV0pcxY5mW4xKRn3v4c=
+github.com/segmentio/ksuid v1.0.4/go.mod h1:/XUiZBD3kVx5SmUOl55voK5yeAbBNNIed+2O73XgrPE=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
 github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
@@ -68,7 +65,6 @@ github.com/valyala/fasttemplate v1.2.1/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20190325154230-a5d413f7728c/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20191205180655-e7c4368fe9dd/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
-golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
 golang.org/x/crypto v0.0.0-20210817164053-32db794688a5/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 h1:7I4JAnoQBe7ZtJcBaYHi5UtiO8tQHbUSXxL+pnGRANg=
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
@@ -101,9 +97,8 @@ golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 h1:Hir2P/De0WpUhtrKGGjvSb2YxUgyZ7EFOSLIcSSpiwE=
 golang.org/x/time v0.0.0-20201208040808-7e3f01d25324/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/square/go-jose.v2 v2.5.1/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI=
-gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

api/main.go

@@ -13,8 +13,8 @@ import (
 
 type Config struct {
 	Port     int    `default:"8080"`
-	TokenKey string `default:"false"`
-	DevMode  bool   `default:"false"`
+	TokenKey string `envconfig:"TOKEN_KEY"`
+	DevMode  bool   `envconfig:"DEV_MODE" default:"false"`
 }
 
 func main() {
@@ -36,6 +36,11 @@ func main() {
 		log.Fatal(err.Error())
 	}
 
+	if config.DevMode {
+		log.Info("starting server in development mode")
+		dbConfig.DevMode = config.DevMode
+	}
+
 	// Initialize DB and routes
 	server.InitRoutes(e, db.InitDB(dbConfig))
 

api/pkg/core/balancer.go

@@ -70,7 +70,7 @@ func calcPlayerPowerScoreForSport(player models.Player, sport models.Sport) floa
 	var powerScore float32
 
 	for skill, weight := range sport.SkillWeights {
-		powerScore += float32(player.Skills[sport.ID.String()][skill]) * weight
+		powerScore += float32(player.Skills[sport.ID][skill]) * weight
 	}
 
 	return powerScore

api/pkg/db/init.go

@@ -39,7 +39,7 @@ func InitDB(dbConfig Config) *gorm.DB {
 		dbConfig.Password,
 	)
 
-	log.Info(dbConfig)
+	log.Info(fmt.Sprintf("%+v", dbConfig))
 
 	// If we're using a development Postgres, disable TLS
 	if dbConfig.DevMode {
@@ -100,6 +100,11 @@ func initPlayersTable(db *gorm.DB) {
 	}
 }
 
+func deleteAllSeedPlayers(db *gorm.DB) {
+	log.Info("deleteing all seed players from existing DB")
+	db.Where("is_seed = ?", "t").Delete(&models.Player{})
+}
+
 func initSportsTable(db *gorm.DB) {
 	log.Info("Populating sports database with initial values..")
 

api/pkg/db/player.go

@@ -5,7 +5,6 @@ import (
 
 	"github.com/adamdevigili/skillbased/api/pkg/models"
 	"github.com/jinzhu/gorm"
-	"github.com/labstack/gommon/log"
 )
 
 func InsertPlayer(db *gorm.DB, player *models.Player) error {
@@ -48,8 +47,3 @@ func DeletePlayer(db *gorm.DB, id string) error {
 		return nil
 	}
 }
-
-func deleteAllSeedPlayers(db *gorm.DB) {
-	log.Info("deleteing all seed players from existing DB")
-	db.Where("is_seed = ?", "t").Delete(&models.Player{})
-}

api/pkg/db/seed.go

@@ -5,40 +5,44 @@ import (
 
 	"github.com/adamdevigili/skillbased/api/pkg/models"
 	"github.com/pioz/faker"
-	"github.com/rs/xid"
+	"github.com/segmentio/ksuid"
 )
 
 var (
 	ultimateFrisbee = models.Sport{
 		Base: models.Base{
 			Name: "Ultimate Frisbee",
-			ID:   xid.New(),
+			ID:   ksuid.New().String(),
 		},
 		SkillWeights: models.SkillWeightMap{
 			"handling": 0.9,
 			"speed":    0.8,
 			"stamina":  0.8,
 			"height":   0.4,
 		},
+		MaxPlayersPerTeam:       15,
+		MaxActivePlayersPerTeam: 7,
 	}
 
 	football = models.Sport{
 		Base: models.Base{
 			Name: "Football",
-			ID:   xid.New(),
+			ID:   ksuid.New().String(),
 		},
 		SkillWeights: models.SkillWeightMap{
 			"strength": 0.7,
 			"speed":    0.8,
 			"stamina":  0.8,
 			"agility":  0.5,
 		},
+		MaxPlayersPerTeam:       50,
+		MaxActivePlayersPerTeam: 11,
 	}
 
 	basketball = models.Sport{
 		Base: models.Base{
 			Name: "Basketball",
-			ID:   xid.New(),
+			ID:   ksuid.New().String(),
 		},
 		SkillWeights: models.SkillWeightMap{
 			"shooting": 0.9,
@@ -47,6 +51,8 @@ var (
 			"height":   0.8,
 			"passing":  0.5,
 		},
+		MaxPlayersPerTeam:       12,
+		MaxActivePlayersPerTeam: 5,
 	}
 
 	initialSports = []models.Sport{
@@ -69,7 +75,7 @@ func generateSeedPlayers() []*models.Player {
 			LastName:  ln,
 			Base: models.Base{
 				Name: fmt.Sprintf("%s %s", fn, ln),
-				ID:   xid.New(),
+				ID:   ksuid.New().String(),
 			},
 			PowerScores: make(map[string]int),
 			IsSeed:      true,