[tools/avatar-platform] feat: initialize project structure

.github/buildConfiguration.yaml

@@ -0,0 +1,11 @@
+builds:
+  - name: Avatar Platform
+    path: tools/avatar-platform
+
+customBuilds:
+  - name: Nightly Job
+    jobName: nightlyJob
+    scriptPath: .github/jenkinsfile/nightlyBuild.groovy
+    triggers:
+      - type: cron
+        schedule: '@midnight'

.github/codecov.yaml

@@ -0,0 +1,25 @@
+# Setting coverage targets per flag
+# Each project represent a package which has one flag
+coverage:
+  status:
+    project:
+      default:
+        target: 95%  # overall project / repo coverage
+
+      avatar-platform:
+        target: auto
+        threshold: 1%
+        flags:
+          - avatar-platform
+
+# New root YAML section = `flags:`
+# This is where you would define every flag from your
+# uploader, and update when new Flags added
+# Each flag is used to represent each package in the
+# monorepo.  This allows code coverage per package.
+
+flags:
+  avatar-platform:
+    paths:
+      - tools/avatar-platform
+    carryforward: true

.github/dependabot.yaml

@@ -0,0 +1,36 @@
+version: 2
+updates:
+
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+      day: sunday
+    target-branch: dev
+    commit-message:
+      prefix: '[dependency]'
+    groups:
+      github-action-dependencies:
+        patterns:
+          - '*'
+        update-types:
+          - minor
+          - patch
+
+  - package-ecosystem: npm
+    directories:
+      - /tools/avatar-platform
+    schedule:
+      interval: weekly
+      day: sunday
+    target-branch: dev
+    versioning-strategy: increase-if-necessary
+    commit-message:
+      prefix: '[dependency]'
+    groups:
+      npm-dependencies:
+        patterns:
+          - '*'
+        update-types:
+          - minor
+          - patch

.github/jenkinsfile/controller.groovy

@@ -0,0 +1,4 @@
+monorepoControllerPipeline {
+	operatingSystem = ['ubuntu']
+	instanceSize = 'small'
+}

.github/jenkinsfile/nightlyBuild.groovy

@@ -0,0 +1 @@
+nightlyBuildPipeline {}

.github/jenkinsfile/seedJob.groovy

@@ -0,0 +1,6 @@
+monorepoSeedPipeline {
+	operatingSystem = ['ubuntu']
+	instanceSize = 'small'
+	organizationName = 'theSymbolSyndicate'
+	gitHubId = 'theSymbolSyndicate-Github-app'
+}

.github/workflows/codeql-analysis.yaml

@@ -0,0 +1,48 @@
+name: Code Scanning - Action
+
+'on':
+  push:
+    branches: [dev, main]
+  pull_request:
+    branches: [dev]
+  schedule:
+    # yamllint disable-line rule:quoted-strings
+    - cron: '44 12 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    timeout-minutes: 360
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [javascript-typescript]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+
+      # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v3
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: /language:${{matrix.language}}

.github/workflows/combine-dependabot-pr.yaml

@@ -0,0 +1,47 @@
+name: Combine PRs
+
+'on':
+  schedule:
+    # yamllint disable-line rule:quoted-strings
+    - cron: '0 2 * * 1'  # Monday at 02:00 AM
+  workflow_dispatch:  # allows you to manually trigger the workflow
+    inputs:
+      logLevel:
+        description: Log level
+        required: true
+        default: warning
+        type: choice
+        options:
+          - info
+          - warning
+          - debug
+
+# The minimum permissions required to run this Action
+permissions:
+  contents: write
+  pull-requests: write
+  repository-projects: write
+  checks: read
+
+jobs:
+  combine-prs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: combine dependabot prs
+        id: combine-prs
+        uses: github/[email protected]
+        with:
+          pr_title: '[dependency]: Combine dependabot PRs'
+          ci_required: true
+          branch_prefix: dependabot
+          labels: dependencies
+          pr_body_header: '# Combined Dependabot PRs ➡️📦⬅️'
+
+      - name: Enable auto-merge for Dependabot PRs
+        if: ${{ steps.combine-prs.outputs.pr_url }}
+        run: gh pr merge --auto --squash --subject "$PR_TITLE" "$PR_URL"
+        env:
+          PR_URL: ${{ steps.combine-prs.outputs.pr_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_TITLE: '[dependency]: Combine dependabot PRs'

.gitlintmodules

@@ -0,0 +1 @@
+tools/avatar-platform

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "_symbol"]
+	path = _symbol
+	url = https://github.com/symbol/symbol
+	branch = dev

init.sh

@@ -0,0 +1,10 @@
+
+#!/bin/bash
+
+set -ex
+
+git submodule update --init
+git -C _symbol config core.sparseCheckout true
+echo 'jenkins/*' >>.git/modules/_symbol/info/sparse-checkout
+echo 'linters/*' >>.git/modules/_symbol/info/sparse-checkout
+git submodule update --force --checkout _symbol

jenkins

@@ -0,0 +1 @@
+_symbol/jenkins

linters

@@ -0,0 +1 @@
+_symbol/linters

tools/avatar-platform/.eslintignore

@@ -0,0 +1,7 @@
+node_modules/
+.next/
+build/
+dist/
+coverage/
+setupTests.js
+next.config.js

tools/avatar-platform/.eslintrc.yaml

@@ -0,0 +1,24 @@
+extends:
+  - ../../_symbol/linters/javascript/default.eslintrc
+  - plugin:tailwindcss/recommended
+  - eslint-config-next
+  - plugin:import/react
+
+rules:
+  import/extensions:
+    - error
+    - always
+    - json: always
+      js: never
+      jsx: never
+  yoda: off
+
+settings:
+  import/resolver:
+    jsconfig:
+      config: jsconfig.json
+
+env:
+  browser: true
+  node: true
+  es2021: true

tools/avatar-platform/.gitignore

@@ -0,0 +1,40 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# env files (can opt-in for commiting if needed)
+.env*
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

tools/avatar-platform/.nycrc.json

@@ -0,0 +1,11 @@
+{
+    "exclude": [
+        "node_modules",
+        "coverage",
+        "dist",
+        "build",
+        "public",
+        "__tests__",
+        "*.config.{js,mj,cj}"
+    ]
+}

tools/avatar-platform/.prettierignore

@@ -0,0 +1,5 @@
+.next/
+node_modules/
+build/
+coverage/
+setupTests.js

tools/avatar-platform/.prettierrc.yaml

@@ -0,0 +1,9 @@
+bracketSpacing: true
+jsxBracketSameLine: false
+singleQuote: true
+trailingComma: none
+tabWidth: 4
+useTabs: true
+arrowParens: avoid
+semi: true
+printWidth: 140

tools/avatar-platform/.stylelintignore

@@ -0,0 +1,7 @@
+node_modules/
+.next/
+build/
+dist/
+coverage/
+setupTests.js
+next.config.js

tools/avatar-platform/.stylelintrc.yaml

@@ -0,0 +1,18 @@
+extends:
+  - stylelint-config-standard-scss
+  - stylelint-config-rational-order
+
+plugins:
+  - stylelint-order
+
+rules:
+  font-family-no-missing-generic-family-keyword: null
+  font-family-name-quotes: always-unless-keyword
+  color-function-notation: legacy
+  selector-class-pattern: '([a-z]+([A-Z][a-z0-9]+)*)'
+  selector-id-pattern: '([a-z]+([A-Z][a-z0-9]+)*)'
+  at-rule-no-unknown: null
+  scss/at-rule-no-unknown:
+    - true
+    - ignoreAtRules:
+        - tailwind

tools/avatar-platform/Jenkinsfile

@@ -0,0 +1,11 @@
+defaultCiPipeline {
+	operatingSystem = ['ubuntu']
+	instanceSize = 'medium'
+
+	ciBuildDockerfile = 'javascript.Dockerfile'
+
+	packageId = 'avatar-platform'
+
+	codeCoverageTool = 'c8'
+	minimumCodeCoverage = 95
+}