Merge pull request #12 from yiliansource/feature/development-assistance

Feature/development assistance, closes #11

Author: lucasstarsz

.eslintignore

@@ -0,0 +1,9 @@
+# ignore configs
+.eslintrc.js
+babel.config.js
+docusaurus.config.js
+
+# ignore built directories
+node_modules
+build
+.docusaurus

.eslintrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+    root: true,
+    env: {
+        browser: true,
+    },
+    plugins: ["@typescript-eslint", "prettier"],
+    rules: {
+        "prettier/prettier": "error",
+    },
+    extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+};

.github/workflows/cd.yml

@@ -0,0 +1,40 @@
+#
+#   This workflow builds and deploys the site whenever the main branch changes, to ensure that it
+#   doesn't have to be done manually. It can also be triggered manually, if desired.
+#
+
+name: Continuous Deployment
+
+on:
+    workflow_dispatch:
+
+    push:
+        branches:
+            - main
+
+jobs:
+    CD:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+
+            - name: Use Node.js
+              uses: actions/setup-node@v2
+              with:
+                  node-version: 12.x
+
+            # Install using the frozen lockfile, to maximize speed.
+            - name: Install dependancies
+              run: yarn install --frozen-lockfile
+
+            # Build the Docusaurus source to static files.
+            - name: Build
+              run: yarn build
+
+            # Deploy the resulting static files to the 'gh-pages' branch.
+            - name: Deploy to GitHub Pages
+              uses: JamesIves/github-pages-deploy-action@4.1.1
+              with:
+                  branch: gh-pages
+                  folder: ./build

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+#
+#   This workflow builds the site on pull requests to the main branch, to ensure that, prior to deployment,
+#   the site can be successfully built without errors. This also verifies linting and style guides.
+#
+
+name: Continuous Integration
+
+on:
+    pull_request:
+        branches:
+            - main
+
+jobs:
+    CI:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+
+            - name: Use Node.js
+              uses: actions/setup-node@v2
+              with:
+                  node-version: 12.x
+
+            # Install using the frozen lockfile, to maximize speed.
+            - name: Install dependancies
+              run: yarn install --frozen-lockfile
+
+            # Verify the style guides.
+            - name: Lint codebase
+              run: yarn lint
+
+            # Build the Docusaurus source to static files.
+            # If this command succeeds, a valid build can be produced.
+            - name: Build
+              run: yarn build

.prettierignore

@@ -0,0 +1,5 @@
+/node_modules
+/build
+.docusaurus
+
+*.md

.prettierrc

@@ -0,0 +1,10 @@
+{
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "semi": true,
+    "singleQuote": false,
+    "printWidth": 120,
+    "endOfLine": "auto",
+    "importOrder": ["^@core/(.*)$", "^@server/(.*)$", "^@ui/(.*)$", "^[./]"],
+    "importOrderSeparation": true
+}

babel.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+    presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
 };