Merge pull request #53 from cgreggtcd/dev

Release 1

Author: cgreggtcd

.env

@@ -0,0 +1,8 @@
+MYSQLDB_USER=root
+MYSQLDB_ROOT_PASSWORD=123456
+MYSQLDB_DATABASE=metrics_db
+MYSQLDB_LOCAL_PORT=3307
+MYSQLDB_DOCKER_PORT=3306
+
+SPRING_LOCAL_PORT=8080
+SPRING_DOCKER_PORT=8080

.github/workflows/docker-deploy.yml

@@ -0,0 +1,39 @@
+name: Docker Image CI
+
+on:
+  create:
+    tags:
+      - "v*.*.*"
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check  out Repo
+      uses: actions/checkout@v3
+      
+    - name: Login to Docker Hub
+      uses: docker/login-action@v1
+      with:
+        username: ${{ secrets.DOCKER_HUB_USERNAME }}
+        password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+    
+    - name: Set up Docker Buildx
+      id: buildx
+      uses: docker/setup-buildx-action@v1
+      
+    - name: Build and push
+      id: docker_build
+      uses: docker/build-push-action@v2
+      with:
+        context: ./
+        file: ./Dockerfile
+        push: true
+        tags: ${{ secrets.DOCKER_HUB_USERNAME }}/software-engineering-metrics:release-1
+    
+    - name: Image digest
+      run:  echo ${{ steps.docker_build.outputs.digest }}
+        

.github/workflows/maven.yml

@@ -5,9 +5,9 @@ name: Java CI with Maven
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "dev" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "main","dev" ]
 
 jobs:
   build:
@@ -18,5 +18,13 @@ jobs:
     - uses: actions/setup-java@v1
       with:
         java-version: 17
+    - name: Write application properties (Github API key)
+      uses: DamianReeves/write-file-action@master
+      with:
+        path: src/main/resources/application.properties
+        write-mode: overwrite
+        contents: |
+          github.access.token=${{ secrets.ACCESS_TOKEN }}
+    
     - name: Build with Maven
-      run: mvn -B package --file pom.xml
+      run: mvn test

.gitignore

@@ -1,5 +1,6 @@
 HELP.md
 target/
+.m2/
 !.mvn/wrapper/maven-wrapper.jar
 !**/src/main/**/target/
 !**/src/test/**/target/
@@ -31,3 +32,4 @@ build/
 
 ### VS Code ###
 .vscode/
+src/main/resources/application.properties

Demo.mp4

@@ -1,5 +1,7 @@
-FROM openjdk:17
+FROM maven:3.8.3-openjdk-17
+
 WORKDIR /app
-EXPOSE 8080
-COPY target/*.jar /app/app.jar
-CMD ["java", "-jar", "app.jar"]
+COPY . .
+RUN mvn clean install
+
+CMD mvn spring-boot:run

Dockerfile

@@ -2,37 +2,11 @@
 This project is to develop a dashboard for the presentation of a range of metrics and visualisations useful to software engineers.
 
 ## Setup Instructions
-### Run Version on GitHub
 
-To run the version on GitHub, clone the repo to your desktop. 
+If you haven't done this yet, create a file named `application.properties` and inside, put the following
 
-#### Run by Script (recommended)
+    github.access.token=<your-github-access-token>
+    
+You can make a GitHub access token as described [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-fine-grained-personal-access-token).
 
-Run the webapp by right-clicking on setup.bat and selecting `run`.
-
-Then, you can open the web app on localhost:8080. This will also run tests!
-
-
-#### Run from Command Line
-
-Open a terminal in the directory of the repo. Then, run
-
-    ./mvnw clean install spring-boot:run   
-
-Then, you can open the web app on localhost:8080. This will also run tests!
-
-### Run Containerised
-
-If you want to run the web app in a container, first clone the repo to your desktop. Open a terminal in the directory of the repo. Then, run
-
-    ./mvnw clean install spring-boot:run  
-
-This will create the jar file. Then, run the following to build the image.
-
-    docker build -t metrics-image . 
-
-To run the webapp, run
-
-    docker run --name=metrics-container --rm -d -p 8080:8080 metrics-image
-
-Then, you can open the web app on localhost:8080.
+Then, usually, you can run by running run.bat or just typing `docker-compose up` into terminal. If you're making changes to the app however, you will need to run setup.bat or type `docker-compose build` then `docker-compose up` into terminal.

README.md

@@ -0,0 +1,38 @@
+version: '3.8'
+
+services:
+  mysqldb:
+    image: mysql:5.7
+    restart: unless-stopped
+    env_file: ./.env
+    environment:
+      - MYSQL_ROOT_PASSWORD=$MYSQLDB_ROOT_PASSWORD
+      - MYSQL_DATABASE=$MYSQLDB_DATABASE
+    ports:
+      - $MYSQLDB_LOCAL_PORT:$MYSQLDB_DOCKER_PORT
+    volumes:
+      - db:/var/lib/mysql
+  app:
+    depends_on:
+      - mysqldb
+    build: .
+    restart: on-failure
+    ports:
+      - $SPRING_LOCAL_PORT:$SPRING_DOCKER_PORT
+    environment:
+       - 'SPRING_APPLICATION_JSON={
+                  "spring.datasource.url"  : "jdbc:mysql://mysqldb:$MYSQLDB_DOCKER_PORT/$MYSQLDB_DATABASE?useSSL=false",
+                  "spring.datasource.username" : "$MYSQLDB_USER",
+                  "spring.datasource.password" : "$MYSQLDB_ROOT_PASSWORD",
+                  "spring.jpa.properties.hibernate.dialect" : "org.hibernate.dialect.MySQL5InnoDBDialect",
+                  "spring.jpa.hibernate.ddl-auto" : "update",
+                  "spring.datasource.driver-class-name" : "com.mysql.cj.jdbc.Driver"
+                }'
+
+    volumes:
+      - .m2:/root/.m2
+    stdin_open: true
+    tty: true
+
+volumes:
+  db: