[misc: Reduce build complexity (#17)

* reduce build complexity

* use vite

* pagination (work in progress)

* refetch on party event

* prepare release

Author: tom-schoener

Dockerfile

@@ -1,10 +1,12 @@
 # Go 
 FROM golang:1.19-alpine AS go-builder
-RUN apk add --no-cache make upx
+RUN apk add --no-cache upx
 
-WORKDIR /app 
+WORKDIR /app
 COPY api .
-RUN make go-build-for-docker
+RUN go mod download
+RUN go build -o bin/group-challenge --tags release -ldflags "-s -w"
+RUN upx bin/group-challenge
 
 #########
 
@@ -22,12 +24,12 @@ RUN npm run build
 #########
 
 # Executable
-FROM alpine
+FROM alpine:3.16
 RUN apk --no-cache add ca-certificates
 
 WORKDIR /app
-COPY --from=go-builder /app/group-challenge .
-COPY --from=react-builder /app/build/ ./static
+COPY --from=go-builder /app/bin/group-challenge .
+COPY --from=react-builder /app/dist/ ./static
 
 ENV GIN_MODE=release
 CMD [ "./group-challenge" ]

README.md

@@ -3,40 +3,23 @@
 [![Docker](https://github.com/subshell/group-challenge/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/subshell/group-challenge/actions/workflows/docker-publish.yml)
 
 An easy-to-use website to create submission-based challenges that will be evaluated together in real-time.
-Any user is allowed to create challenges with a fixed start and end date while others join and
-contribute. Currently supported challenges are:
+Any user is allowed to create challenges with a fixed start and end date while others join and contribute.
+Currently supported challenges are:
 
 - 📸 **Photo Challenge**
 
 ![Start Screen](.github/start_screen.png)
 
-## Local development
-
-This project includes pre-configured configuration files to launch the api, frontend, and postgres in VS Code. Alternatively you can start all services with the following commands:
-
-1. **Postgres:** start a postgres db at port `5432`.
-
-```sh
-  mkdir /tmp/group-challenge-cache
-  docker-compose up
-```
-
-2. **API:** start the go api server at port `8080`.
-
-```sh
-  cd api && go run ./cmd/group-challenge/root.go
-```
+## Configuration
 
-3. **Frontend:** start the frontend at port `3000`.
-
-```sh
-  cd frontend && npm start
-```
+The configuration is usally located under `/app/config.yaml`.
+We also support configuration via environment variabels with a `GC_` prefix:
 
-## Run in Docker
+- `GC_SERVER_PORT`
+- `GC_DB_USER`
+- `GC_DB_PASSWORD`
 
-The Dockerimage requires a config file `/app/config.yaml`. Env variables are also supported. They have a `GC_` prefix,
-for example: `GC_SERVER_PORT`. The postgreSQL database is not part of the Dockerimage and has to be started separately.
+**All available configuration options:**
 
 ```yaml
 server:
@@ -60,7 +43,62 @@ imgProxy:
   fullSizeQuality: 75
 ```
 
-### Kubernetes support
+## Local development
+
+This project includes pre-configured configuration files to launch the api, frontend, and postgres in VS Code.
+Alternatively you can start all services with the following commands:
+
+1. **Postgres:** start a postgres db at port `5432`.
+
+```sh
+  mkdir /tmp/group-challenge-cache
+  docker-compose up
+```
+
+2. **API:** start the go api server at port `8080`.
+
+```sh
+  cd api && go run ./cmd/group-challenge/root.go
+```
+
+3. **Frontend:** start the frontend at port `3000`.
+
+```sh
+  cd frontend && npm run dev
+```
+
+## Container
+
+For official container images visit https://github.com/subshell/group-challenge/pkgs/container/group-challenge
+
+### Building the container
+
+The container contains the frontend as well as the backend.
+
+```sh
+  docker build . --tag group-challenge
+```
+
+### Running the container
+
+Before you can run the `group-challenge` container, make sure that postgresql and optionally imgProxy is running.
+You can start both applications with `mkdir /tmp/group-challenge-cache && docker-compose up`.
+
+By default you can open your browser at http://localhost:8080/ to see the running group-challenge app.
+
+#### Your localy created container
+
+```sh
+  docker run --network=host group-challenge
+```
+
+#### Official container
+
+```sh
+  docker run --network=host ghcr.io/subshell/group-challenge:latest
+```
+
+## Kubernetes support
 
 The helm chart is available under https://subshell.github.io/helm-charts-lab/
 
@@ -78,8 +116,6 @@ You definitely want to change the password using `global.postgresql.postgresqlPa
 
 To reduce the size of all uploaded images, we support [imgProxy](https://docs.imgproxy.net). See `imgProxy` for its configuration.
 
-
-* * *
+---
 
 Take a look at this project from the [subshell](https://subshell.com) team. We make [Sophora](https://subshell.com/sophora/): a content management software for content creation, curation, and distribution. [Join our team!](https://subshell.com/jobs/) | [Imprint](https://subshell.com/about/imprint/)
-

api/.gitignore

@@ -20,4 +20,4 @@ vendor
 
 __debug_bin
 tmp
-/group-challenge
+bin/group-challenge

api/Makefile

@@ -2,8 +2,12 @@
 
 ## Run locally
 
-    make go-run
+    go run main.go
 
-## Build Package
+## Build package
 
-    make go-build
+    go build -o bin/group-challenge
+
+## Reduce package size
+
+    upx bin/group-challenge

api/README.md

@@ -28,15 +28,15 @@ func init() {
 	// config defaults
 	viper.SetDefault("server.port", 8080)
 	viper.SetDefault("server.staticFilesDir", "./static")
-	viper.SetDefault("db.User", "")
-	viper.SetDefault("db.Password", "")
-	viper.SetDefault("db.Database", "postgres")
-	viper.SetDefault("db.Host", "localhost:5432")
-	viper.SetDefault("db.PoolSize", 50)
+	viper.SetDefault("db.user", "")
+	viper.SetDefault("db.password", "")
+	viper.SetDefault("db.database", "postgres")
+	viper.SetDefault("db.host", "localhost:5432")
+	viper.SetDefault("db.poolSize", 50)
 	viper.SetDefault("challenges.party.live.defaultTimePerSubmissionSeconds", 45)
 	viper.SetDefault("imgProxy.enabled", false)
 	viper.SetDefault("imgProxy.url", "http://localhost:8081")
-	viper.SetDefault("imgProxy.SharedLocalCacheDir", "/tmp/group-challenge-cache")
+	viper.SetDefault("imgProxy.sharedLocalCacheDir", "/tmp/group-challenge-cache")
 	viper.SetDefault("imgProxy.thumbnailQuality", 75)
 	viper.SetDefault("imgProxy.fullSizeQuality", 75)
 	viper.SetDefault("imgProxy.maxFullWidth", 1280)

api/go.mk

@@ -11,6 +11,7 @@ import (
 	"mime/multipart"
 	"net/http"
 	"path/filepath"
+	"strconv"
 	"time"
 
 	"github.com/gin-gonic/gin"
@@ -30,6 +31,12 @@ type partyRequestBody struct {
 	EndDate     time.Time `json:"endDate"`
 }
 
+type paginationResponseBody struct {
+	PageSize int             `json:"pageSize"`
+	Page     int             `json:"page"`
+	Data     []*models.Party `json:"data"`
+}
+
 type partySubmissionMetaBody struct {
 	Name        string `json:"name"`
 	Description string `json:"description"`
@@ -52,16 +59,34 @@ func broadcastParty(operation string, party *models.Party) {
 }
 
 func partiesHandler(c *gin.Context) {
+	pageSize := 5
+
+	pageString := c.Request.URL.Query().Get("page")
+	if pageString == "" {
+		pageString = "0"
+	}
+	page, err := strconv.Atoi(pageString)
+	if err != nil {
+		log.Println("[ERROR]", "page param is not an integer", pageString)
+		c.Status(http.StatusBadRequest)
+		return
+	}
+
 	parties := []*models.Party{}
-	err := models.GetAllParties(&parties, con)
+	err = models.GetAllParties(&parties, page, pageSize, con)
 
 	if err != nil {
 		log.Println("[ERROR]", err)
 		c.Status(500)
 		return
 	}
 
-	c.JSON(200, parties)
+	response := paginationResponseBody{}
+	response.Data = parties
+	response.Page = page
+	response.PageSize = pageSize
+
+	c.JSON(200, response)
 }
 
 func addPartyHandler(c *gin.Context) {

api/cmd/group-challenge/root.go renamed to api/main.go

@@ -132,8 +132,8 @@ func (submission *PartySubmission) Update(con *pg.DB) error {
 }
 
 // GetAllParties returns all parties
-func GetAllParties(parties *[]*Party, con *pg.DB) error {
-	err := con.Model(parties).Limit(200).Select()
+func GetAllParties(parties *[]*Party, page int, limit int, con *pg.DB) error {
+	err := con.Model(parties).Offset(page * limit).Limit(limit).Order("end_date desc").Select()
 
 	if err != nil {
 		return err

api/pkg/group-challenge/api/party-api.go

@@ -1,23 +1,24 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
 
-# dependencies
 node_modules
-/.pnp
-.pnp.js
-
-# testing
-coverage
-
-# production
-build
+dist
+dist-ssr
+*.local
 
-# misc
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
 .DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?