initial commit

shinee0401 · Mar 17, 2024 · e9f5232 · e9f5232
commit e9f5232
Show file tree

Hide file tree

Showing 302 changed files with 12,768 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,18 @@
+---
+name: "Bug report \U0001F41B"
+about: "Create a bug report to help us improve"
+title: "Bug report:"
+---
+
+## A brief summary of the bug
+
+<!-- A precise and clear explanation of what the bug is. -->
+
+## Expected vs actual outcome
+
+<!-- A precise and clear description of the expected outcome and the actual outcome observed. -->
+
+## Additional context
+
+- Screenshots, if applicable
+- Environment details (e.g. browser, operating system, version of the project)
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,14 @@
+---
+name: "Feature request \U0001F680"
+about: "Suggest an idea for this project"
+title: "Feature request:"
+---
+
+## A brief summary of the feature
+
+<!-- A precise and clear description of the desired functionality or the task the feature is intended to perform. -->
+
+## Additional context
+
+- Screenshots or mockups, if applicable
+- Any references or examples of similar features in other projects
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,46 @@
+# Type of change
+
+- [ ] Added, Removed or Updated GitHub Profile README
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Improvement
+
+## Describe change does this PR introduce?
+
+<!--
+If you've added, removed, or updated your GitHub Profile README, please take a moment to describe the changes.
+--->
+
+<!--
+Similarly, if you've made any changes to your site, please provide a clear and precise description of the changes, including any relevant motivation and context. Additionally, please list any dependencies that are required for this change to be implemented.
+--->
+
+## Related Issue (If any)
+
+Fixes/Implements #(issue number)
+
+## Checklist
+
+- [ ] The commit message follows our guidelines.
+- [ ] The code has been self reviewed and tested.
+- [ ] Added or Updated Github Profile README.
+  - [ ] The Github Profile README is impressive and visually appealing.
+  - [ ] Added it below the heading of the category in alphabetical order.
+
+## Additional context
+
+<!--
+If you've added, removed, or updated your GitHub Profile README:
+
+- Link of the Github Profile
+- Screenshots of the Github Profile README
+- Any other relevant information
+--->
+
+<!--
+Similarly, if you've made any changes to the site:
+
+- Screenshots or mockups, if applicable
+- Environment details (e.g. browser, operating system, version of the project)
+- Any other relevant information
+--->
diff --git a/.github/workflows/refresh-data-workflow.yml b/.github/workflows/refresh-data-workflow.yml
@@ -0,0 +1,132 @@
+name: Auto Refresh Data Workflow
+
+on:
+  schedule:
+    # triggers the workflow every 15 days
+    - cron: "0 0 1 * *"
+
+jobs:
+  # This job refresh data
+  refresh-data:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          ref: main
+          fetch-depth: 0
+
+      # Cache node modules for faster builds
+      - name: Cache node modules
+        uses: actions/cache@v3
+        with:
+          path: site/node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+
+      # Install Node.js
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      # Install Chromium for puppeteer
+      - name: Install Chromium
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y chromium-browser
+
+      # Clean Install npm packages
+      - name: Install npm packages
+        run: npm ci
+        working-directory: site/
+
+      # Refresh data
+      - name: Refresh data
+        run: npm run refresh
+        working-directory: site/
+
+      # Generate README.json and Screenshots
+      - name: Generate data
+        run: CHROME_BIN=$(which chromium-browser) npm run generate
+        working-directory: site/
+
+      # Format and lint code
+      - name: Format and lint code
+        run: npm run format && npm run lint
+        working-directory: site/
+
+      # Commit and Push the refresh data
+      - name: Commit and Push refresh data
+        uses: EndBug/add-and-commit@v9
+        with:
+          author_name: "github-actions[bot]"
+          author_email: "41898282+github-actions[bot]@users.noreply.github.com"
+          message: "Refresh data"
+          add: .
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  # This job wait for 60 seconds to make sure the data is updated
+  wait:
+    needs: refresh-data
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Wait for 60 seconds
+        run: sleep 60
+
+  # This job builds and deploys the site
+  build-and-deploy:
+    needs: wait
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          ref: main
+          fetch-depth: 0
+
+      # Cache node modules for faster builds
+      - name: Cache node modules
+        uses: actions/cache@v3
+        with:
+          path: site/node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+
+      # Install Node.js
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      # Clean Install npm packages
+      - name: Install npm packages
+        run: npm ci
+        working-directory: site/
+
+      # Build the site
+      - name: Build the site
+        run: |
+          npm run build
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN  }}
+        working-directory: site/
+
+      # Deploy to GitHub Pages
+      - name: Deploy to GitHub Pages
+        run: |
+          git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com" 
+          git config user.name "github-actions[bot]"
+          npm run deploy -- -m "Deploy refresh data to site (${{ github.sha }})"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        working-directory: site/
diff --git a/.github/workflows/site-deploy-workflow-with-data-update.yml b/.github/workflows/site-deploy-workflow-with-data-update.yml
@@ -0,0 +1,140 @@
+name: Site Deployment Workflow with Data Update
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "README.md"
+      - "screenshots/**"
+  pull_request:
+    branches: [main]
+    types: [closed]
+    paths:
+      - "README.md"
+      - "screenshots/**"
+    condition: github.event.pull_request.merged == true
+
+jobs:
+  # This job generates latest data
+  generate-data:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          ref: main
+          fetch-depth: 0
+
+      # Cache node modules for faster builds
+      - name: Cache node modules
+        uses: actions/cache@v3
+        with:
+          path: site/node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+
+      # Install Node.js
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      # Install Chromium for puppeteer
+      - name: Install Chromium
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y chromium-browser
+
+      # Clean Install npm packages
+      - name: Install npm packages
+        run: npm ci
+        working-directory: site/
+
+      # Generate README.json and Screenshots
+      - name: Generate data
+        run: CHROME_BIN=$(which chromium-browser) npm run generate
+        working-directory: site/
+
+      # Format and lint code
+      - name: Format and lint code
+        run: npm run format && npm run lint
+        working-directory: site/
+
+      # Commit and Push the generated data
+      - name: Commit and Push generated data
+        uses: EndBug/add-and-commit@v9
+        with:
+          author_name: "github-actions[bot]"
+          author_email: "41898282+github-actions[bot]@users.noreply.github.com"
+          message: "Update latest generated data"
+          add: .
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  # This job wait for 60 seconds to make sure the data is updated
+  wait:
+    needs: generate-data
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Wait for 60 seconds
+        run: sleep 60
+
+  # This job builds and deploys the site
+  build-and-deploy:
+    needs: wait
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          ref: main
+          fetch-depth: 0
+
+      # Cache node modules for faster builds
+      - name: Cache node modules
+        uses: actions/cache@v3
+        with:
+          path: site/node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+
+      # Install Node.js
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      # Clean Install npm packages
+      - name: Install npm packages
+        run: npm ci
+        working-directory: site/
+
+      # Build the site
+      - name: Build the site
+        run: |
+          npm run build
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN  }}
+        working-directory: site/
+
+      # Deploy to GitHub Pages
+      - name: Deploy to GitHub Pages
+        run: |
+          git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com" 
+          git config user.name "github-actions[bot]"
+          if git diff --quiet --exit-code site/; then
+            npm run deploy -- -m "Deploy latest generated data to site (${{ github.sha }})"
+          else
+            npm run deploy -- -m "Deploy latest data and changes to site (${{ github.sha }})"
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        working-directory: site/