initial commit

NINAnor · Jan 22, 2024 · 5f456a4 · 5f456a4
commit 5f456a4
Show file tree

Hide file tree

Showing 40 changed files with 6,804 additions and 0 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -0,0 +1,24 @@
+module.exports = {
+    root: true,
+    env: { browser: true, es2020: true },
+    extends: [
+      'eslint:recommended',
+      'plugin:react/recommended',
+      'plugin:react/jsx-runtime',
+      'plugin:react-hooks/recommended',
+    ],
+    ignorePatterns: ['dist', '.eslintrc.cjs'],
+    parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
+    settings: { react: { version: '18.2' } },
+    plugins: ['react-refresh'],
+    rules: {
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+      'react/prop-types': [
+        'warn',
+      ],
+    },
+  }
+
diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml
@@ -0,0 +1,41 @@
+name: Docker
+on:
+  push:
+  pull_request:
+    branches: ["main"]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Login to registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=sha
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,27 @@
+datasets/*/
+!datasets/example-*
+
+# 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/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.0.1"
+    hooks:
+      - id: prettier
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,17 @@
+FROM node:18 as frontend
+WORKDIR /app
+COPY package.json package-lock.json .
+RUN npm i
+COPY src src/
+COPY public public/
+COPY vite.config.js index.html .
+
+CMD ["npm", "run", "dev"]
+
+FROM frontend as build
+RUN npm run build
+
+FROM nginx
+
+COPY nginx/default.conf.template /etc/nginx/templates/
+COPY --from=build /app/dist /var/www/
diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+# Northwind maps
+
+Northwind maps is a set of maps for the [Northwind project](https://www.northwindresearch.no/)
+
+
+## Running the webapp
+
+The only requirement is having a web server which supports HTTP bytes serving/ranged requests, such as NGINX.
+
+### Development
+
+```bash
+docker compose --profile dev up --build
+```
+
+Then, the application can be seen by visiting [http://localhost:8000/](http://localhost:8000/).
+
+### Production
+
+Same as development, but using the `prod` profile:
+
+```bash
+docker compose --profile prod up
+```
diff --git a/data/.gitignore b/data/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,32 @@
+x-common-nginx:
+  &common-nginx
+  ports:
+    - 8001:80
+
+services:
+  nginx:
+    <<: *common-nginx
+    profiles:
+      - prod
+    build: .
+    volumes:
+      - ./data:/var/www/data:ro
+  nginx-dev:
+    <<: *common-nginx
+    profiles:
+      - dev
+    image: nginx
+    volumes:
+      - ./data:/var/www/data:ro
+      - ./nginx/dev.conf.template:/etc/nginx/templates/default.conf.template:ro
+
+  vite:
+    build:
+      target: frontend
+    volumes:
+      - ./src:/app/src
+      - ./config.js:/app/public/config.js
+    ports:
+      - "3000:3000"
+    profiles:
+      - dev
diff --git a/index.html b/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Viewer</title>
+    <script src="/config.js"></script>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>
diff --git a/nginx/default.conf.template b/nginx/default.conf.template
@@ -0,0 +1,19 @@
+server {
+    listen       80;
+    server_name  localhost;
+    root   /var/www;
+
+    location ~* ^/data/(.+)/(.+)$ {
+        try_files $uri $uri/;
+    }
+
+    location / {
+        try_files $uri /index.html;
+    }
+
+    error_page   500 502 503 504  /50x.html;
+    location = /50x.html {
+        root   /usr/share/nginx/html;
+    }
+}
+
diff --git a/nginx/dev.conf.template b/nginx/dev.conf.template
@@ -0,0 +1,23 @@
+server {
+    listen       80;
+    server_name  localhost;
+    root   /var/www;
+    absolute_redirect off;
+
+    location ~* ^/data/(.+)/(.+)$ {
+        try_files $uri $uri/;
+    }
+
+    location / {
+        proxy_pass http://vite:3000;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection "Upgrade";
+        proxy_set_header Host $host;
+    }
+
+    error_page   500 502 503 504  /50x.html;
+    location = /50x.html {
+        root   /usr/share/nginx/html;
+    }
+}