Merge pull request #479 from OHDSI/development

Release 0.4

.eslintrc.js

@@ -0,0 +1,24 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+  },
+  extends: [
+    "plugin:vue/vue3-essential",
+    "eslint:recommended",
+    "@vue/typescript/recommended",
+    "plugin:prettier/recommended",
+  ],
+  parser: "vue-eslint-parser",
+  parserOptions: {
+    ecmaVersion: "latest",
+  },
+  rules: {
+    eqeqeq: "warn",
+    "vue/eqeqeq": "warn",
+    "no-shadow": "warn",
+    "no-var": "warn",
+    "prefer-const": "warn",
+    "no-console": "warn",
+  },
+};

.gitignore

@@ -22,7 +22,9 @@ pnpm-debug.log*
 *.njsproj
 *.sln
 *.sw?
-package-lock.json
 
 #Electron-builder output
-/dist_electron
+/dist_electron
+/doc/docs/.vuepress/.cache/
+/doc/docs/.vuepress/.temp/
+/doc/docs/.vuepress/dist/

doc/.github/workflows/deploy-docs.yml

@@ -0,0 +1,47 @@
+
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      # make sure this is the branch you are using
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          # if your docs needs submodules, uncomment the following line
+          # submodules: true
+
+
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install Deps
+        run: npm ci
+
+      - name: Build Docs
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          npm run docs:build
+          > docs/.vuepress/dist/.nojekyll
+
+      - name: Deploy Docs
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          # This is the branch where the docs are deployed to
+          branch: gh-pages
+          folder: docs/.vuepress/dist

doc/docs/.vuepress/config.js

@@ -0,0 +1,20 @@
+import { defaultTheme } from '@vuepress/theme-default'
+import { defineUserConfig } from 'vuepress/cli'
+import { viteBundler } from '@vuepress/bundler-vite'
+
+export default defineUserConfig({
+  lang: 'en-US',
+
+  title: 'Ares',
+  description: 'A Research Exploration System',
+
+  theme: defaultTheme({
+    logo: '../icon.png',
+
+    navbar: ['/', '/ares-docs'],
+    colorMode: 'dark',
+    colorModeSwitch: false,
+
+  }),
+  bundler: viteBundler(),
+})

doc/docs/README.md

@@ -0,0 +1,15 @@
+---
+home: true
+title: Home
+heroImage: /icon.png
+actions:
+  - text: Get Started
+    link: /ares-docs.html#installation
+    type: primary
+
+  - text: Visualizations
+    link: /ares-docs.html#visualizations
+    type: secondary
+
+footer: Apache 2.0 Licensed | Copyright © 2024 OHDSI
+---