ode-explorer 1.0.0-explorer

package/.eslintrc.cjs

@@ -0,0 +1,61 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: [
+    "plugin:react/recommended",
+    "airbnb",
+    "airbnb-typescript",
+    "plugin:import/typescript",
+    "plugin:prettier/recommended",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: false,
+    },
+    ecmaVersion: "latest",
+    sourceType: "module",
+    project: "./tsconfig.json",
+    tsconfigRootDir: __dirname,
+  },
+  plugins: ["react", "@typescript-eslint", "prettier"],
+  rules: {
+    "arrow-parens": "off",
+    "react/react-in-jsx-scope": "off",
+    "react/jsx-uses-react": ["off"],
+    "react/jsx-props-no-spreading": ["warn"],
+    "react/no-unescaped-entities": ["off"],
+    "react/jsx-one-expression-per-line": "off",
+    "@typescript-eslint/quotes": "off",
+    "no-console": "off",
+    "import/order": [
+      "error",
+      {
+        groups: ["builtin", "external", "internal"],
+        pathGroups: [
+          {
+            pattern: "react",
+            group: "external",
+            position: "before",
+          },
+        ],
+        pathGroupsExcludedImportTypes: ["react"],
+        "newlines-between": "always",
+        alphabetize: {
+          order: "asc",
+          caseInsensitive: true,
+        },
+      },
+    ],
+  },
+  ignorePatterns: [
+    "prettier.config.js",
+    "node_modules",
+    "public",
+    "dist",
+    "vite.config.ts",
+    ".eslintrc.cjs",
+  ],
+};

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+cd frontend && yarn pre-commit

package/.prettierignore

@@ -0,0 +1,6 @@
+# Ignore everything:
+/*
+src/vite-env.d.ts
+
+# Except web-app:
+!/src

package/README.md

@@ -0,0 +1,136 @@
+# Open Digital Education Explorer
+
+This is a [ReactJS](https://reactjs.org) + [Vite](https://vitejs.dev) app.
+
+## What is inside?
+
+Many tools are already configured like:
+
+- [ReactJS](https://reactjs.org)
+- [Vite](https://vitejs.dev)
+- [TypeScript](https://www.typescriptlang.org)
+- [...](./TOOLS.md)
+
+[See all tools](./TOOLS.md)
+
+## Getting Started
+
+### Install
+
+Install all dependencies.
+
+```bash
+yarn
+```
+
+## Dev
+
+### Start project
+
+Open your project with Vite Server + HMR at <http://localhost:3000>.
+
+```bash
+yarn dev
+```
+
+### [Server Options](https://vitejs.dev/config/server-options.html)
+
+You can change Vite Server by editing `vite.config.ts`
+
+```bash
+server: {
+  host: "0.0.0.0",
+  port: 3000,
+  open: true // open the page on <http://localhost:3000> when dev server starts.
+}
+```
+
+### Absolute Imports
+
+You should use absolute imports in your app
+
+```bash
+Replace ../components/* by components/*
+```
+
+Edit `vite.config.ts` and add an `alias`
+
+> Telling Vite how to build import path:
+
+```bash
+alias: [
+  { find: "~", replacement: path.resolve(__dirname, "src") },
+  {
+    find: "components",
+    replacement: path.resolve(__dirname, "./src/components"),
+  },
+]
+```
+
+Add your new path to `tsconfig.json`:
+
+> Telling TypeScript how to resolve import path:
+
+```bash
+"baseUrl": "./src",
+"paths": {
+  "components/*": ["./components/*"],
+}
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Prettier
+
+Prettier write and check separately
+
+```bash
+yarn format:write
+yarn format:check
+```
+
+Prettier everything once
+
+```bash
+yarn format
+```
+
+### Lighthouse
+
+> LHCI will check if your app respect at least 90% of these categories: performance, a11y, Best practices and seo
+
+```bash
+yarn lighthouse
+```
+
+### Pre-commit
+
+When committing your work, `pre-commit` will start `yarn lint-staged`:
+
+> lint-staged starts lint + prettier
+
+```bash
+yarn pre-commit
+```
+
+## Build
+
+TypeScript check + Vite Build
+
+```bash
+yarn build
+```
+
+## Preview
+
+```bash
+yarn preview
+```
+
+## License
+
+This project is licensed under the AGPL-3.0 license.

package/TOOLS.md

@@ -0,0 +1,31 @@
+# Tools
+
+## React
+
+- [ReactJS](https://reactjs.org)
+- [React Router](https://reactrouter.com/en/main)
+- [React i18next](https://react.i18next.com/)
+- [React Error Boundary](https://github.com/bvaughn/react-error-boundary#readme)
+
+## Vite
+
+- [Vite](https://vitejs.dev)
+
+## Configuration
+
+- [TypeScript](https://www.typescriptlang.org)
+- [Eslint](https://eslint.org)
+- [Prettier](https://prettier.io)
+- [Husky](https://github.com/typicode/husky)
+
+## Hooks
+
+- [SWR](https://swr.vercel.app/)
+
+## Utilities
+
+- [CLSX](https://github.com/lukeed/clsx#readme)
+
+## Lighthouse
+
+- [Lighthouse CI](https://github.com/GoogleChrome/lighthouse-ci)

package/index.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Blog</title>
+    <link
+      id="theme"
+      rel="stylesheet"
+      href="/assets/themes/ode-bootstrap-neo/skins/default/theme.css"
+    />
+  </head>
+  <body>
+    <!-- blog, collaborativeeditor, collaborativewall, exercizer, mindmap, pages, timelinegenerator, wiki, scrapbook -->
+    <div data-ode-app='{"app":"blog"}'></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/lighthouserc.json

@@ -0,0 +1,37 @@
+{
+  "ci": {
+    "collect": {
+      "url": ["http://localhost:5173/"],
+      "startServerCommand": "rails server -e production",
+      "staticDistDir": "./dist",
+      "settings": {
+        "onlyCategories": [
+          "performance",
+          "accessibility",
+          "best-practices",
+          "seo"
+        ]
+      }
+    },
+    "assert": {
+      "assertions": {
+        "categories:performance": [
+          "error",
+          { "minScore": 0.9, "aggregationMethod": "median-run" }
+        ],
+        "categories:accessibility": [
+          "error",
+          { "minScore": 0.9, "aggregationMethod": "pessimistic" }
+        ],
+        "categories:best-practices": [
+          "error",
+          { "minScore": 0.9, "aggregationMethod": "pessimistic" }
+        ],
+        "categories:seo": [
+          "error",
+          { "minScore": 0.9, "aggregationMethod": "pessimistic" }
+        ]
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "ode-explorer",
+  "version": "1.0.0-explorer",
+  "description": "Open Digital Education Explorer",
+  "homepage": "https://github.com/opendigitaleducation/explorer#readme",
+  "bugs": {
+    "url": "https://github.com/opendigitaleducation/explorer/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/opendigitaleducation/explorer.git"
+  },
+  "license": "GPL-3.0",
+  "author": "Open Digital Education",
+  "scripts": {
+    "build": "tsc && vite build",
+    "clean": "concurrently \"yarn:clean:*\"",
+    "clean:dist": "rm -rf dist",
+    "clean:lighthouse": "rm -rf .lighthouseci",
+    "clean:modules": "rm -rf node_modules",
+    "clean:package": "rm -rf yarn.lock",
+    "dev": "vite",
+    "fix": "eslint --fix .",
+    "format": "concurrently \"yarn:format:*\"",
+    "format:check": "yarn prettier --check .",
+    "format:write": "yarn prettier --write .",
+    "lighthouse": "yarn clean:lighthouse && lhci autorun",
+    "lint": "eslint .",
+    "pre-commit": "lint-staged",
+    "prepare": "cd .. && husky install frontend/.husky",
+    "preview": "vite preview"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "gitDir": "../",
+    "**/*.{js,jsx,ts,tsx}": [
+      "yarn format:write",
+      "yarn fix"
+    ]
+  },
+  "dependencies": {
+    "@ode-react-ui/core": "dev",
+    "@ode-react-ui/hooks": "dev",
+    "@ode-react-ui/icons": "dev",
+    "clsx": "1.2.1",
+    "i18next": "21.9.2",
+    "i18next-browser-languagedetector": "6.1.5",
+    "i18next-http-backend": "1.4.4",
+    "ode-ts-client": "feat-explorer",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "react-error-boundary": "3.1.4",
+    "react-i18next": "11.18.6",
+    "react-router-dom": "6.4.1",
+    "swr": "1.3.0"
+  },
+  "devDependencies": {
+    "@types/node": "18.7.23",
+    "@types/react": "18.0.21",
+    "@types/react-dom": "18.0.6",
+    "@typescript-eslint/eslint-plugin": "5.38.1",
+    "@typescript-eslint/parser": "5.38.1",
+    "@vitejs/plugin-react": "2.1.0",
+    "concurrently": "7.4.0",
+    "eslint": "8.24.0",
+    "eslint-config-airbnb": "19.0.4",
+    "eslint-config-airbnb-typescript": "17.0.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-jsx-a11y": "6.6.1",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-react": "7.31.8",
+    "eslint-plugin-react-hooks": "4.6.0",
+    "husky": "8.0.1",
+    "lint-staged": "13.0.3",
+    "prettier": "2.7.1",
+    "typescript": "4.8.3",
+    "vite": "3.1.3"
+  }
+}

package/prettier.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "all",
+  "printWidth": 80,
+  "useTabs": false,
+  "endOfLine": "auto"
+}