prod

.github/workflows/test-build.yaml

@@ -17,8 +17,12 @@ jobs:
 
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Set up Docker
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v3
       - name: Build Docker Image
-        run: docker build -t gearfest-backend .
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: false
+          tags: test

.github/workflows/unit-test.yaml

@@ -0,0 +1,30 @@
+name: "Pull request/Push: Unit test"
+
+on:
+  pull_request:
+    branches:
+      - dev
+      - main
+  push:
+    branches:
+      - dev
+      - main
+jobs:
+  test:
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: "1.21.5"
+      - name: Install dependencies
+        run: go mod download
+      - name: Vet
+        run: go vet ./...
+      - name: Test
+        run: |
+          go test  -v -coverpkg ./src/... -coverprofile coverage.out -covermode count ./tests/...
+          go tool cover -func="./coverage.out"

.gitignore

@@ -3,4 +3,8 @@
 .temp
 
 .env
-config.yaml
+config.yaml
+
+# coverage report
+coverage.out
+coverage.html

README.md

@@ -12,7 +12,8 @@ Backend interface for the GearFestival website.
 
 1. Clone this repo.
 2. Copy `config.local.yaml` in `config` and paste it in the same directory with `.local` removed from its name.
-3. Run `go mod download` to download all the dependencies.
+3. Replace `<client_id>` with your Google OAuth client id in `config.yaml`.
+4. Run `go mod download` to download all the dependencies.
 
 ## Running
 
@@ -21,7 +22,9 @@ Backend interface for the GearFestival website.
    > Note: You have to install [Docker](https://docs.docker.com/get-docker/) and [Supabase CLI](https://github.com/supabase/cli) before running this command.
 
 2. Run `go run ./src/` to start server.
-3. Server should be running on `localhost:8080` and `localhost:54323/project/default/editor` for database editor.
+3. The server should be running on `localhost:8080`, `localhost:8080/swagger/index.html` for Swagger UI, and `localhost:54323/project/default/editor` for database editor.
+
+   > Note: If there are no tables on the database, please run `supabase db reset` to apply migrations.
 
 Ensure to run `supabase stop` to close supabase after finishing your code.
 
@@ -54,10 +57,12 @@ Ensure to run `supabase stop` to close supabase after finishing your code.
 1. Wait for the code to be reviewed and merged
 1. Repeat
 
-   > Note: Don't forget to always pull the latest changes from the dev branch before creating a new branch.
+   > Note: Don't forget to always pull the latest changes from the dev branch and apply migrations on supabase before creating a new branch.
    >
    > ```bash
    > git pull origin dev
+   >
+   > supabase db reset
    > ```
 
 ### Conventional Commit Format

config/config.local.yaml

@@ -1,9 +1,10 @@
-database:
+supabase:
   host: 127.0.0.1
   user: postgres
   password: postgres
   dbname: postgres
   port: "54322"
   sslmode: disable
-  timezone: Asia/Shanghai
   schema: public
+google:
+  client_id: <client_id>