Feature/hyp 45 init (#1)

* Added the initial readme with a small intro added to it * Added the initial package.json * Replaced dot gitignore * Added license * Added the initial readme * Added info about assets * Added start and build inside package json * Added depcheck rc, what to ignore when using depcheck. * Added App.js, Home.js and utils/Router ( Router for / ) * Added dev npm run script in package json ( webpack-dev-server ). * Added depcheck script npm run command , cleaned up .depcheckrc and removed axios * Added fonts * Cleaned up the React code * Added lint and lint:fix npm run commands * Added package lock json * Added codeOfConduct and Contrib md , PR template md , and bug_report + feature_request md. * Added codeowners * Small fix * Added Dockerfile and git workflows for release * Added info about dev * Added renovate and docker compose * Fixed LICENSE and fixed link in package json
digicatapult · Dec 13, 2023 · af3b863 · af3b863
1 parent 3126e22
commit af3b863
Show file tree

Hide file tree

Showing 31 changed files with 12,461 additions and 123 deletions.
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,7 @@
+{
+  "presets": ["@babel/preset-env", "@babel/preset-react"],
+  "plugins": [
+    "@babel/plugin-syntax-dynamic-import",
+    "@babel/plugin-proposal-class-properties"
+  ]
+}
diff --git a/.depcheckrc b/.depcheckrc
@@ -0,0 +1,7 @@
+ignores: [
+  "depcheck",
+  "*loader",
+  "webpack",
+  "webpack-cli",
+  "@babel/preset-react"
+]
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,4 @@
+node_modules
+build
+package.json
+webpack.config.js
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,43 @@
+{
+  "extends": [
+    "plugin:react/recommended",
+    "prettier"
+  ],
+  "plugins": ["react", "prettier", "react-hooks", "cypress"],
+  "parser": "@babel/eslint-parser",
+  "parserOptions": {
+    "requireConfigFile": false,
+    "sourceType": "module",
+    "babelOptions": {
+      "presets": ["@babel/preset-react"]
+    }
+  },
+  "env": {
+    "es6": true,
+    "browser": true,
+    "node": true
+  },
+  "globals": {
+    "process": true
+  },
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
+  },
+  "rules": {
+    "no-console": "error",
+    "prettier/prettier": ["error", { "singleQuote": true }],
+    "react/jsx-filename-extension": 0,
+    "react/require-default-props": 0,
+    "react/sort-comp": 0,
+    "react/destructuring-assignment": 0,
+    "react/no-access-state-in-setstate": 0,
+    "react/no-danger": 0,
+    "no-useless-constructor": "error",
+    "react-hooks/rules-of-hooks": "error",
+    "react-hooks/exhaustive-deps": "warn",
+    "react/prop-types": "off",
+    "no-unused-vars": ["error", { "ignoreRestSiblings": true }]
+  }
+}
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,4 @@
+# Github CODEOWNERS file
+
+# Global code-owners for this repository
+* @digicatapult/software-engineering
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,46 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+<!--
+
+Have you read our Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/digicatapult/dscp-hyproof-client/.github/blob/main/CODE_OF_CONDUCT.md
+
+-->
+
+### Prerequisites
+
+- [ ] Put an X between the brackets on this line if you have done all of the following:
+  - Checked the FAQs for common solutions: <https://github.com/digicatapult/dscp-hyproof-client/blob/main/CONTRIBUTING.md/#FAQs>
+  - Checked that your issue isn't already filed: <https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Adscp-hyproof-client>
+
+### Description
+
+<!-- Description of the issue -->
+
+### Steps to Reproduce
+
+1. <!-- First Step -->
+2. <!-- Second Step -->
+3. <!-- and so on… -->
+
+**Expected behaviour:**
+
+<!-- What you expect to happen -->
+
+**Actual behaviour:**
+
+<!-- What actually happens -->
+
+**Reproduces how often:**
+
+<!-- What percentage of the time does it reproduce? -->
+
+### Versions
+
+<!-- You can get this information from copy and pasting the version on the home page or via package.json. Also, please include the OS and what version of the OS you're running. -->
+
+### Additional Information
+
+<!-- Any additional information, configuration or data that might be necessary to reproduce the issue. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,29 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+
+<!--
+
+Have you read our Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/digicatapult/dscp-hyproof-client/.github/blob/main/CODE_OF_CONDUCT.md
+
+---
+Also note that the Digital Catapult team has finite resources so it's unlikely that we'll work on feature requests. If we're interested in a particular feature however, we'll follow up and ask you to submit an RFC to talk about it in more detail.
+
+-->
+
+## Summary
+
+<!-- One paragraph explanation of the feature. -->
+
+## Motivation
+
+<!-- Why are we doing this? What use cases does it support? What is the expected outcome? -->
+
+## Describe alternatives you've considered
+
+<!-- A clear and concise description of the alternative solutions you've considered. Be sure to explain why the existing customisability isn't suitable for this feature. -->
+
+## Additional context
+
+<!-- Add any other context or screenshots about the feature request here. -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,10 @@
+⚛👋 Hello there! Welcome. Please follow the steps below to tell us about your contribution.
+
+1. Copy the correct template for your contribution
+
+   - 🐛 Are you fixing a bug? Copy the template from <https://github.com/digicatapult/dscp-hyproof-client/blob/main/.github/ISSUE_TEMPLATE/bug_report.md>
+   - 💻 Are you changing functionality? Copy the template from <https://github.com/digicatapult/dscp-hyproof-client/blob/main/.github/ISSUE_TEMPLATE/feature_request.md>
+
+2. Replace this text with the contents of the template
+3. Fill in all sections of the template
+4. Click "Create pull request"
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,188 @@
+name: Release
+
+on:
+  push:
+    branches: ["main"]
+
+jobs:
+
+  preconditions:
+    runs-on: ubuntu-latest
+    outputs:
+      repo_name: ${{ steps.repo_ids.outputs.REPO_NAME }}
+      org_name: ${{ steps.repo_ids.outputs.ORG_NAME }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Check token
+        run: |
+          if [ -z "${{ secrets.GITHUB_TOKEN }}"]; then
+            echo "Must provide a GITHUB_TOKEN secret in order to run release workflow"
+            exit 1
+          fi
+      - name: Get repository identifiers
+        id: repo_ids
+        run: |
+          REPO_NAME=$(echo "${{ github.event.repository.name }}" | tr '[:upper:]' '[:lower:]')
+          ORG_NAME=$(echo "${{ github.event.repository.owner.name }}" | tr '[:upper:]' '[:lower:]')
+          echo "REPO_NAME=$REPO_NAME" >> $GITHUB_OUTPUT
+          echo "ORG_NAME=$ORG_NAME" >> $GITHUB_OUTPUT
+
+  lint:
+    name: Run lint
+    runs-on: ubuntu-latest
+    needs: [preconditions]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Cache Node.js modules
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
+          key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.OS }}-node-
+            ${{ runner.OS }}-
+      - name: Install Packages
+        run: npm ci
+      - name: Lint
+        run: npm run lint
+
+  dependency-check:
+    name: Run dependency check
+    runs-on: ubuntu-latest
+    needs: [preconditions]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Cache Node.js modules
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
+          key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.OS }}-node-
+            ${{ runner.OS }}-
+      - name: Install Packages
+        run: npm ci
+      - name: Dependency Check
+        run: npm run depcheck
+
+  check-version:
+    name: "Check version"
+    runs-on: ubuntu-latest
+    outputs:
+      is_new_version: ${{ steps.get_version.outputs.IS_NEW_VERSION }}
+      version: ${{ steps.get_version.outputs.VERSION }}
+      build_date: ${{ steps.get_version.outputs.BUILD_DATE }}
+      is_prerelease: ${{ steps.get_version.outputs.IS_PRERELEASE }}
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check version
+        id: get_version
+        uses: digicatapult/check-version@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    name: "Publish package"
+    needs: [preconditions, lint, dependency-check, tests, check-version]
+    runs-on: ubuntu-latest
+    if: ${{ needs.check-version.outputs.is_new_version == 'true' }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # Docker build
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v3
+        with:
+          platforms: all
+      - name: Setup Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          buildkitd-flags: "--debug"
+      - name: Generate tags
+        id: generate-tags
+        env:
+          VERSION: ${{ needs.check-version.outputs.version }}
+          IS_NEW_VERSION: ${{ needs.check-version.outputs.is_new_version }}
+          IS_PRERELEASE: ${{ needs.check-version.outputs.is_prerelease }}
+        # if it's a new non prerelease version tag with hash, version latest-dev and latest
+        # if it's a new prerelease version tag with hash, version and latest-dev
+        # if it's a non new version tag with hash and latest-dev
+        run: |
+          if [ "$IS_NEW_VERSION" == "true" ]; then
+            echo "GHCR_VERSION_TAG=ghcr.io/${{ needs.preconditions.outputs.org_name }}/${{ needs.preconditions.outputs.repo_name }}:$VERSION" >> $GITHUB_OUTPUT
+            echo "DOCKERHUB_VERSION_TAG=${{ needs.preconditions.outputs.org_name }}/${{ needs.preconditions.outputs.repo_name }}:$VERSION" >> $GITHUB_OUTPUT
+            if [ "$IS_PRERELEASE" == "false" ]; then
+              echo "GHCR_LATEST_TAG=ghcr.io/${{ needs.preconditions.outputs.org_name }}/${{ needs.preconditions.outputs.repo_name }}:latest" >> $GITHUB_OUTPUT
+              echo "DOCKERHUB_LATEST_TAG=${{ needs.preconditions.outputs.org_name }}/${{ needs.preconditions.outputs.repo_name }}:latest" >> $GITHUB_OUTPUT
+            else
+              echo "GHCR_LATEST_TAG=" >> $GITHUB_OUTPUT
+              echo "DOCKERHUB_LATEST_TAG=" >> $GITHUB_OUTPUT
+            fi;
+          else
+            echo "GHCR_VERSION_TAG=" >> $GITHUB_OUTPUT
+            echo "GHCR_LATEST_TAG=" >> $GITHUB_OUTPUT
+            echo "DOCKERHUB_VERSION_TAG=" >> $GITHUB_OUTPUT
+            echo "DOCKERHUB_LATEST_TAG=" >> $GITHUB_OUTPUT
+          fi;
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Login to Dockerhub Registry
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DSCP_DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DSCP_DOCKERHUB_TOKEN }}
+      - name: Build image
+        uses: docker/build-push-action@v5
+        with:
+          builder: ${{ steps.buildx.outputs.name }}
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64, linux/arm64
+          push: true
+          tags: |
+            ghcr.io/${{ needs.preconditions.outputs.org_name }}/${{ needs.preconditions.outputs.repo_name }}:${{ github.sha }}
+            ${{ steps.generate-tags.outputs.GHCR_VERSION_TAG }}
+            ${{ steps.generate-tags.outputs.GHCR_LATEST_TAG }}
+            ${{ needs.preconditions.outputs.org_name }}/${{ needs.preconditions.outputs.repo_name }}:${{ github.sha }}
+            ${{ steps.generate-tags.outputs.DOCKERHUB_VERSION_TAG }}
+            ${{ steps.generate-tags.outputs.DOCKERHUB_LATEST_TAG }}
+          labels: |
+            org.opencontainers.image.title=${{ needs.preconditions.outputs.repo_name }}
+            org.opencontainers.image.description=${{ github.event.repository.description }}
+            org.opencontainers.image.source=${{ github.event.repository.html_url }}
+            org.opencontainers.image.url=${{ github.event.repository.html_url }}
+            org.opencontainers.image.revision=${{ github.sha }}
+            org.opencontainers.image.version=${{ needs.check-version.outputs.version }}
+            org.opencontainers.image.created=${{ needs.check-version.outputs.build_date }}
+
+      # Build github release
+      - name: Build release version
+        uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          automatic_release_tag: ${{ needs.check-version.outputs.version }}
+          prerelease: false
+          title: Release ${{ needs.check-version.outputs.version }}
+      - name: Build release latest
+        uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          automatic_release_tag: latest
+          prerelease: false
+          title: Latest Release ${{ needs.check-version.outputs.version }}