v1.0.0 Release

.github/workflows/deploy-backend.yml

@@ -1,34 +1,64 @@
-name: Deploy Backend
+name: Test and Deploy Backend
 
-on: [ push, pull_request ]
+on: [ push ]
 
 jobs:
   test:
     runs-on: "ubuntu-latest"
     steps:
-      - name: 'Checkout github action'
+      - name: Checkout repo
         uses: actions/checkout@v4
-        
+
       - name: Setup golang
         uses: actions/setup-go@v5
         with:
           go-version: '1.22'
-          
+
       - name: Install dependencies
         run: |
           go install gotest.tools/gotestsum@latest
           go get ./...
-        
+
       - name: Build
-        run: go build -o . ./...
-        
-      - name: Run Tests
+        run: go build -o ./main ./app
+
+      - name: Run tests
         run: gotestsum --hide-summary=skipped ./app/tests/... > tests-result.txt
-        
+
       - name: Upload tests result
         uses: actions/upload-artifact@v4
         with:
           name: tests-result
           path: tests-result.txt
-  # deploy:
-  #   if: github.event_name == 'pull_request' && github.ref == 'refs/heads/main'
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: test
+    if: contains('
+      refs/heads/dev
+      refs/heads/main
+      ', github.ref)
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Log in to Docker Hub
+        uses: docker/#-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Extract metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: edoriggio/api-scout
+
+      - name: Build and push image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -21,8 +21,10 @@ go.work
 .vscode/
 .DS_Store
 
-ca.crt
+*.crt
 *.config.yml
 !config/template.config.yml
 models/*
-!.keep
+!.keep
+
+mongo-ids.txt

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: detect-private-key
+  - repo: https://github.com/dnephin/pre-commit-golang
+    rev: v0.5.0
+    hooks:
+      - id: go-unit-tests
+#  - repo: local
+#    hooks:
+#      - id: generate-go-docs
+#        name: generate-go-docs
+#        entry: ./scripts/hooks/generate-go-docs.sh
+#        language: system
+#      - id: generate-swagger-docs
+#        name: generate-swagger-docs
+#        entry: ./scripts/hooks/generate-swagger-docs.sh
+#        language: system

Dockerfile

@@ -6,17 +6,18 @@ COPY go.* ./
 RUN go mod download
 
 COPY . .
-RUN go build -o /backend/build/app ./app/cmd/main
+RUN go install github.com/swaggo/swag/cmd/swag@latest
+RUN cd app && swag init
+RUN go build -o /backend/build/app /backend/app
 
 FROM alpine:latest
 
 WORKDIR /backend
 
-ENV GIN_MODE="release"
-ENV MODELS_HOST="models"
+ARG GIN_MODE
+ARG MODELS_HOST
 
 COPY --from=builder /backend/build/app /backend/build/app
-COPY --from=builder /backend/config /backend/config
 
 EXPOSE 8080
 ENTRYPOINT [ "/backend/build/app" ]

README.md

@@ -1,13 +1,14 @@
-# API Scout - Backend
+# API Scout
+## Configure
 
-## Set ENV Variables
+### Set ENV Variables
 
 The following are the variables that need to be set:
 
 - `GIN_MODE`: In which mode Gin should be running (can be `release` or `debug`)
 - `MODELS_HOST`: The hostname of the DL models container (use `models` if in release mode, `127.0.0.1` if in debug mode)
 
-## Downloading USE Model
+### Downloading USE Model
 
 To download the Universal Sentence Encoder (USE) model, run the python script in `scripts/download-use.py` by running the following commands (you should run these commands while in the `backend` directory):
 
@@ -18,7 +19,7 @@ conda run -n api-scout python ./scripts/download-use.py
 
 You will now have a new directory in `models` called `universal-encoder`. This model will be used by the `docker-compose.yml` file to serve the model in a container.
 
-## Spinning up the Containers
+### Spinning up the Containers
 
 For replication purposes, in this repo you will find both a `Dockerfile` and a `docker-compose.yml` file. The `Dockerfile` will create a Docker image with a build of the Golang backend in it. To create the image, simply run:
 
@@ -34,6 +35,33 @@ docker-compose up -d
 
 This will create a Docker container for the Golang backend and for the USE model. The backend will now be able to make HTTP calls to the USE model to embed queries and documents. N.B.: The USE container will not expose any ports, it will be called locally by the backend by means of the `be-network` shared network.
 
-## Dependencies
+### Dependencies
 
 For the backend to work, both an ElasticSearch instance and a MongoDB instance should be up and running.
+
+## Documentation
+
+To generate and consult the documentation, you can use the following commands.
+
+### Generate Documentation
+
+To generate the documentation, first you need to make sure that you have all the necessary dependencies installed. Run the following commands:
+
+```shell
+go install go.abhg.dev/doc2go@latest
+npm install -g pagefind@latest
+```
+
+Once all dependencies have been installed, run:
+
+```shell
+doc2go -config ./app/internal/doc2go.rc ./app/internal/...
+```
+
+### Consult Documentation
+
+To consult the documentation of the `app/internal` API, run the following command:
+
+```shell
+cd docs && python -m http.server 8000
+```