nginx · ryepup · Aug 31, 2023 · Aug 30, 2023 · Aug 31, 2023
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -7,7 +7,7 @@
       "BASE_IMG": "mcr.microsoft.com/devcontainers/typescript-node:0-18-bullseye"
     }
   },
-  "postCreateCommand": "sudo chown node:node reference-lib/node_modules",
+  "postCreateCommand": "sudo find . -name node_modules -exec chown node:node {} \\;",
   "remoteUser": "node",
   "customizations": {
     "vscode": {
@@ -24,7 +24,7 @@
         "files.trimTrailingWhitespace": true,
         "files.insertFinalNewline": true,
         "editor.formatOnSave": true,
-        "[typescript][json][jsonc][yaml][markdown][javascript]": {
+        "[typescript][typescriptreact][json][jsonc][yaml][markdown][javascript]": {
           "editor.defaultFormatter": "esbenp.prettier-vscode",
           "editor.codeActionsOnSave": {
             "source.fixAll": true
@@ -39,6 +39,7 @@
   },
   "mounts": [
     // keep node_modules in the container for speed on macos/windows
-    "source=${localWorkspaceFolderBasename}-reference-lib-node_modules,target=${containerWorkspaceFolder}/reference-lib/node_modules,type=volume"
+    "source=${localWorkspaceFolderBasename}-reference-lib-node_modules,target=${containerWorkspaceFolder}/reference-lib/node_modules,type=volume",
+    "source=${localWorkspaceFolderBasename}-examples-ref-browser-node_modules,target=${containerWorkspaceFolder}/examples/ref-browser/node_modules,type=volume"
   ]
 }
diff --git a/README.md b/README.md
@@ -21,6 +21,7 @@ The repository is organized as follows:
 - `reference-lib/`: This directory contains an npm package that allows for easy lookup of nginx directives
 - `reference-converter/`: This directory contains a program that converts the official NGINX reference documentation from XML format to JSON.
 - `tools/`: This directory contains development tools
+- `examples/`: This directory contains example usage of the `reference-lib`
 
 ## Contributing
 

diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,3 @@
+# examples
+
+These applications demonstrate potential uses of the `reference-lib`.
diff --git a/examples/ref-browser/.eslintrc.cjs b/examples/ref-browser/.eslintrc.cjs
@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}
diff --git a/examples/ref-browser/.gitignore b/examples/ref-browser/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/examples/ref-browser/README.md b/examples/ref-browser/README.md
@@ -0,0 +1,9 @@
+# ref-browser
+
+Small website to search and browse NGINX directives. This is useful for testing changes to the reference converter.
+
+## Getting Started
+
+- in `reference-lib`, run `npm run build` - this codebase links to that one
+- `npm ci` to install dependencies
+- `npn run dev` starts a local server
diff --git a/examples/ref-browser/index.html b/examples/ref-browser/index.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>NGINX directive browser</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>