migrate from goserve to example project

Author: janishar

.dockerignore

@@ -0,0 +1,53 @@
+# Binaries
+/server
+/server.exe
+
+# Vendor directory (if not using Go modules)
+vendor/
+
+# OS-specific files
+*.exe
+*.dll
+*.so
+*.dylib
+
+# Test output
+*.out
+
+# Logs
+*.log
+
+# Coverage files
+*.cover
+*.coverage
+*.cov
+
+# Build directories
+bin/
+obj/
+build/
+dist/
+
+# IDE/editor directories and files
+.vscode/
+.idea/
+*.swp
+*~
+
+# Git
+.git/
+.gitignore
+
+# Docker
+.dockerignore
+Dockerfile
+
+# Dependency management files
+go.sum
+
+# Any other files you want to exclude
+.DS_Store 
+.github/
+.tools/
+logs/
+*.md

.editorconfig

@@ -0,0 +1,34 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Go files
+[*.go]
+indent_style = tab
+indent_size = 2
+
+# JavaScript files
+[*.js]
+indent_style = space
+indent_size = 2
+
+# Markdown files
+[*.md]
+max_line_length = 80
+trim_trailing_whitespace = false
+
+# JSON files
+[*.json]
+indent_style = space
+indent_size = 2
+
+# YAML files
+[*.yml, *.yaml]
+indent_style = space
+indent_size = 2

.env.example

@@ -0,0 +1,30 @@
+# debug, release, test
+GO_MODE=debug
+
+SERVER_HOST=0.0.0.0
+SERVER_PORT=8080
+
+DB_HOST=mongo
+DB_PORT=27017
+DB_NAME=goserver-dev-db
+DB_USER=goserver-dev-db-user
+DB_USER_PWD=changeit
+DB_MIN_POOL_SIZE=2
+DB_MAX_POOL_SIZE=5
+DB_QUERY_TIMEOUT_SEC=60
+DB_ADMIN=admin
+DB_ADMIN_PWD=changeit
+
+REDIS_HOST=redis
+REDIS_PORT=6379
+REDIS_PASSWORD=changeit
+
+# 2 DAYS: 172800 Sec
+ACCESS_TOKEN_VALIDITY_SEC=172800
+# 7 DAYS: 604800 Sec
+REFRESH_TOKEN_VALIDITY_SEC=604800
+TOKEN_ISSUER=api.goserve.afteracademy.com
+TOKEN_AUDIENCE=goserve.afteracademy.com
+
+RSA_PRIVATE_KEY_PATH="keys/private.pem"
+RSA_PUBLIC_KEY_PATH="keys/public.pem"

.extra/docs/goserve-banner.png

@@ -0,0 +1,65 @@
+function seed(dbName, user, password) {
+  db = db.getSiblingDB(dbName);
+  db.createUser({
+    user: user,
+    pwd: password,
+    roles: [{ role: "readWrite", db: dbName }],
+  });
+
+  db.createCollection("api_keys");
+  db.createCollection("roles");
+
+  db.api_keys.insert({
+    key: "1D3F2DD1A5DE725DD4DF1D82BBB37",
+    permissions: ["GENERAL"],
+    comments: ["To be used by the xyz vendor"],
+    version: 1,
+    status: true,
+    createdAt: new Date(),
+    updatedAt: new Date(),
+  });
+
+  db.roles.insertMany([
+    {
+      code: "LEARNER",
+      status: true,
+      createdAt: new Date(),
+      updatedAt: new Date(),
+    },
+    {
+      code: "AUTHOR",
+      status: true,
+      createdAt: new Date(),
+      updatedAt: new Date(),
+    },
+    {
+      code: "EDITOR",
+      status: true,
+      createdAt: new Date(),
+      updatedAt: new Date(),
+    },
+    {
+      code: "ADMIN",
+      status: true,
+      createdAt: new Date(),
+      updatedAt: new Date(),
+    },
+  ]);
+
+  db.users.insert({
+    name: "Admin",
+    email: "[email protected]",
+    password: "$2a$10$psWmSrmtyZYvtIt/FuJL1OLqsK3iR1fZz5.wUYFuSNkkt.EOX9mLa", // hash of password: changeit
+    roles: db.roles
+      .find({})
+      .toArray()
+      .map((role) => role._id),
+    status: true,
+    createdAt: new Date(),
+    updatedAt: new Date(),
+  });
+}
+
+seed("goserver-prod-db", "goserver-prod-db-user", "changeit");
+seed("goserver-dev-db", "goserver-dev-db-user", "changeit");
+seed("goserver-test-db", "goserver-test-db-user", "changeit");

.extra/docs/goserve-cover.png

@@ -0,0 +1,29 @@
+name: Docker Compose CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Create .env
+      run: cp .env.example .env
+    - name: Create .test.env
+      run: cp .test.env.example .test.env
+    - name: Create pems
+      run: go run .tools/rsa/keygen.go
+    - name: Build docker images
+      run: docker compose build
+    - name: Run docker images
+      run: docker compose up -d
+    - name: Run tests
+      run: docker exec -t goserver go test -v ./...
+    - name: Clean up
+      if: success() || failure()
+      run: docker compose down --rmi all -v --remove-orphans

.extra/docs/request-flow.svg

@@ -0,0 +1,38 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+.DS_Store
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+!Dockerfile.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# Environment varibles
+*.env
+*.env.test
+
+#keys
+keys/*
+!keys/*.md
+!keys/*.txt
+*.pem
+
+__debug*
+
+build

.extra/setup/init-mongo.js

@@ -0,0 +1,27 @@
+# debug, release, test
+GO_MODE=test
+
+DB_HOST=mongo
+DB_PORT=27017
+DB_NAME=goserver-test-db
+DB_USER=goserver-test-db-user
+DB_USER_PWD=changeit
+DB_MIN_POOL_SIZE=2
+DB_MAX_POOL_SIZE=5
+DB_QUERY_TIMEOUT_SEC=60
+DB_ADMIN=admin
+DB_ADMIN_PWD=changeit
+
+REDIS_HOST=redis
+REDIS_PORT=6379
+REDIS_PASSWORD=changeit
+
+# 2 DAYS: 172800 Sec
+ACCESS_TOKEN_VALIDITY_SEC=172800
+# 7 DAYS: 604800 Sec
+REFRESH_TOKEN_VALIDITY_SEC=604800
+TOKEN_ISSUER=api.goserve.afteracademy.com
+TOKEN_AUDIENCE=goserve.afteracademy.com
+
+RSA_PRIVATE_KEY_PATH="../keys/private.pem"
+RSA_PUBLIC_KEY_PATH="../keys/public.pem"