Merge pull request #31 from enisz/docs-to-angular

Migrate documentation from React to Angular

.editorconfig

@@ -0,0 +1,16 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.ts]
+quote_type = single
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

.github/workflows/update-documentation.yml → .github/workflows/deploy-docs.yml

@@ -1,12 +1,12 @@
-name: Update Documentation
+name: Deploy Documentation
 on:
   push:
     branches:
       - "documentation"
 
 jobs:
   publish:
-    name: Publishing Documentation
+    name: Deploying Documentation
     runs-on: ubuntu-latest
     steps:
       - uses: docker://node:18-alpine
@@ -16,14 +16,14 @@ jobs:
 
       - name: Building Application
         run: |
-          export NODE_OPTIONS=--openssl-legacy-provider
           npm ci
+          npm run db:prod
           npm run build
-          cp ./build/index.html ./build/404.html
+          cp ./dist/igdb-docs/browser/index.html ./dist/igdb-docs/browser/404.html
 
       - name: Publishing
         uses: JamesIves/[email protected]
         with:
           branch: documentation
-          folder: ./build
+          folder: ./dist/igdb-docs/browser
           target-folder: ./docs

.gitignore

@@ -1,26 +1,47 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+# See http://help.github.com/ignore-files/ for more about ignoring files.
 
-# dependencies
+.vscode
+
+# Compiled output
+/dist
+/tmp
+/out-tsc
+/bazel-out
+
+# Node
 /node_modules
-/.pnp
-.pnp.js
+npm-debug.log
+yarn-error.log
 
-# testing
-/coverage
+# IDEs and editors
+.idea/
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
 
-# production
-/build
+# Visual Studio Code
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history/*
 
-# misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
+# Miscellaneous
+/.angular/cache
+.sass-cache/
+/connect.lock
+/coverage
+/libpeerconnection.log
+testem.log
+/typings
 
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+# System files
+.DS_Store
+Thumbs.db
 
-public/database.json
-public/images
+src/assets/database.json
+logs

README.md

@@ -1,82 +1,27 @@
-# Getting Started with Create React App
+# IgdbDocs
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.0.3.
 
-## Available Scripts
+## Development server
 
-In the project directory, you can run:
+Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
 
-### `npm start`
+## Code scaffolding
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+## Build
 
-### `npm test`
+Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+## Running unit tests
 
-### `npm run build`
+Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+## Running end-to-end tests
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+## Further help
 
-### `npm run watch:templates`
-
-Building the non-production database from the templates and will watch for further changes in the files. If a change is detected, the whole database is built again.
-
-### `npm run export:templates`
-
-Exporting a non-production database from the templates one time. The json file will be indented.
-
-### `npm run export:templates:production`
-
-Exporting the production database from the templates one time. The json file will be compressed, the whitespaces will be removed.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.

angular.json

@@ -0,0 +1,109 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "igdb-docs": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "style": "scss"
+        }
+      },
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:application",
+          "options": {
+            "outputPath": "dist/igdb-docs",
+            "index": "src/index.html",
+            "browser": "src/main.ts",
+            "polyfills": [
+              "zone.js"
+            ],
+            "tsConfig": "tsconfig.app.json",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              "src/favicon.ico",
+              "src/assets",
+              "src/manifest.webmanifest"
+            ],
+            "styles": [
+              "node_modules/@fortawesome/fontawesome-free/css/all.min.css",
+              "node_modules/highlight.js/styles/atom-one-dark.css",
+              "src/styles.scss"
+            ],
+            "scripts": [
+              "node_modules/@popperjs/core/dist/umd/popper.min.js",
+              "node_modules/bootstrap/dist/js/bootstrap.min.js"
+            ]
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "1mb",
+                  "maximumError": "1.5mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "2kb",
+                  "maximumError": "4kb"
+                }
+              ],
+              "outputHashing": "all",
+              "serviceWorker": "ngsw-config.json"
+            },
+            "development": {
+              "optimization": false,
+              "extractLicenses": false,
+              "sourceMap": true
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "configurations": {
+            "production": {
+              "buildTarget": "igdb-docs:build:production"
+            },
+            "development": {
+              "buildTarget": "igdb-docs:build:development"
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "buildTarget": "igdb-docs:build"
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "polyfills": [
+              "zone.js",
+              "zone.js/testing"
+            ],
+            "tsConfig": "tsconfig.spec.json",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              "src/favicon.ico",
+              "src/assets",
+              "src/manifest.webmanifest"
+            ],
+            "styles": [
+              "src/styles.scss"
+            ],
+            "scripts": []
+          }
+        }
+      }
+    }
+  }
+}

db/assets/mustache/blockquote.mustache

@@ -0,0 +1,11 @@
+<div class="callout-block callout-block-{{severity}}">
+    <div class="content">
+        <h4 class="callout-title">
+            <span class="callout-icon-holder me-1">
+                <i class="fas {{icon}}"></i>
+            </span>
+            {{title}}
+        </h4>
+        {{{quote}}}
+    </div>
+</div>

db/assets/mustache/image.mustache

@@ -0,0 +1,4 @@
+<figure class="figure docs-figure py-3 w-100 text-center">
+    <img class="img-fluid" src="{{src}}" />
+    <figcaption class="figure-caption mt-3">{{text}}</figcaption>
+</figure>

db/assets/mustache/link.mustache

@@ -0,0 +1,6 @@
+<a
+    href="{{#local}}documentation{{{href}}}{{/local}}{{^local}}{{{href}}}{{/local}}"
+    title="{{title}}{{^local}} (external link){{/local}}"
+    target="{{#local}}_self{{/local}}{{^local}}_blank{{/local}}"
+    >
+        {{{text}}}{{^local}} <i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>{{/local}}</a>

db/assets/mustache/tabset.mustache

@@ -0,0 +1,18 @@
+<strong>{{name}}</strong>
+
+<ul class="nav nav-tabs" id="tablist-{{id}}" role="tablist">
+{{#tabs}}
+    <li class="nav-item" role="presentation">
+        <button class="nav-link{{#active}} active{{/active}}" id="tab-{{id}}" data-bs-toggle="tab" data-bs-target="#pane-{{id}}" type="button" role="tab" aria-controls="pane-{{id}}">
+            {{ title }}
+        </button>
+    </li>
+{{/tabs}}
+</ul>
+<div class="tab-content border-start border-end border-bottom" id="content-{{id}}">
+{{#tabs}}
+    <div class="tab-pane fade show{{#active}} active{{/active}}" id="pane-{{id}}" role="tabpanel" aria-labelledby="tab-{{id}}" tabindex="0">
+        {{{ content }}}
+    </div>
+{{/tabs}}
+</div>