Restructure and documentation

.eslintrc.cjs

@@ -0,0 +1,90 @@
+const { resolve } = require('path');
+module.exports = {
+  // https://eslint.org/docs/user-guide/configuring#configuration-cascading-and-hierarchy
+  // This option interrupts the configuration hierarchy at this file
+  // Remove this if you have an higher level ESLint config file (it usually happens into a monorepos)
+  root: true,
+
+  // https://eslint.vuejs.org/user-guide/#how-to-use-custom-parser
+  // Must use parserOptions instead of "parser" to allow vue-eslint-parser to keep working
+  // `parser: 'vue-eslint-parser'` is already included with any 'plugin:vue/**' config and should be omitted
+  parserOptions: {
+    // https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#configuration
+    // https://github.com/TypeStrong/fork-ts-checker-webpack-plugin#eslint
+    // Needed to make the parser take into account 'vue' files
+    extraFileExtensions: ['.vue'],
+    parser: '@typescript-eslint/parser',
+    project: resolve(__dirname, './tsconfig.json'),
+    tsconfigRootDir: __dirname,
+    ecmaVersion: 2018, // Allows for the parsing of modern ECMAScript features
+    sourceType: 'module' // Allows for the use of imports
+  },
+
+  env: {
+    browser: true
+  },
+
+  ignorePatterns: [
+    'vite.config.js'
+  ],
+
+  // Rules order is important, please avoid shuffling them
+  extends: [
+    // Base ESLint recommended rules
+    // 'eslint:recommended',
+
+    // https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#usage
+    // ESLint typescript rules
+    'plugin:@typescript-eslint/recommended',
+    // consider disabling this class of rules if linting takes too long
+    'plugin:@typescript-eslint/recommended-requiring-type-checking'
+  ],
+
+  plugins: [
+    // required to apply rules which need type information
+    '@typescript-eslint',
+    'import'
+  ],
+
+  // add your custom rules here
+  rules: {
+    // allow async-await
+    'generator-star-spacing': 'off',
+    // allow paren-less arrow functions
+    'arrow-parens': 'off',
+    'one-var': 'off',
+    'no-void': 'off',
+    'multiline-ternary': 'off',
+    'curly': 'error',
+    'import/first': 'off',
+    'import/namespace': 'error',
+    'import/default': 'error',
+    'import/export': 'error',
+    'import/extensions': 'off',
+    'import/no-unresolved': 'off',
+    'import/no-extraneous-dependencies': 'off',
+    'prefer-promise-reject-errors': 'off',
+    'space-before-function-paren': 'error',
+    semi: [2, 'always'],
+    indent: ['error', 2],
+    // causes issues in Typescript when enabled
+    'no-unused-vars': 'off',
+
+    // TypeScript
+    quotes: ['warn', 'single', { avoidEscape: true }],
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-unnecessary-type-assertion': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+    '@typescript-eslint/no-misused-promises': 'off',
+    '@typescript-eslint/no-unsafe-argument': 'off',
+    '@typescript-eslint/no-unused-vars': [2, { args: 'none' }],
+
+    // allow debugger during development only
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
+  }
+};

.github/workflows/deploy.yml

@@ -0,0 +1,57 @@
+name: Deploy
+
+on:
+  push:
+    # branches:
+    # - master
+
+env:
+  BASE_URL: /StuffInSpace/
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        uses: bahmutov/npm-install@v1
+
+      - name: Build project
+        run: |
+          bin/generate-appinfo.sh public/appinfo.json
+          cp public/appinfo.json src/appinfo.json
+          npm run build
+
+      - name: Upload production-ready build files
+        uses: actions/upload-artifact@v3
+        with:
+          name: production-files
+          path: ./dist
+
+  deploy:
+    name: Deploy
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: production-files
+          path: ./dist
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./dist

.gitignore

@@ -1,2 +1,18 @@
-*.ini
-TLE.json
+node_modules
+.DS_Store
+logs/
+*.env
+.cookiejar
+
+# Devenv
+.direnv
+.devenv*
+devenv.local.nix
+
+.devenv
+old
+dist
+tmp
+
+# VSCode Local Settings
+.vscode/settings.json

.stylelintignore

@@ -0,0 +1,4 @@
+/tmp/
+*.cjs
+*.json
+*.txt

.vscode/tasks.json

@@ -0,0 +1,17 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "dev",
+			"problemMatcher": [],
+			"label": "npm: dev",
+			"detail": "vite --host",
+			"isBackground": true,
+			"icon": {
+				"id": "symbol-method",
+				"color": "terminal.ansiBlue"
+			}
+		}
+	]
+}

README.md

@@ -0,0 +1,39 @@
+# Stuff in Space
+
+Original author: James Yoder (https://github.com/jeyoder)
+
+A real-time interactive WebGL visualisation of objects in Earth orbit.
+
+## Running for Development
+
+ 1. Install dependencies: `npm run install`
+ 2. Run the project `npm run dev`
+
+Connect to it at http://localhost:5173
+
+## Building for Deployment
+
+ 1. Install dependencies: `npm run install`
+ 2. Build the project `npm run build`
+
+The resulting assets will be in the `dist` folder, which you can
+then make available on your website.
+
+Note, the current setup assumes the project will be run at the root
+of the website.
+
+## Getting TLE data
+
+While TLE data (Two-Line Elements) is included in the project, it won't be up to date.
+
+If you wish to get current TLE data, then head over to [Space Track](https://www.space-track.org/),
+login and then you can use the following URL:
+
+https://www.space-track.org/basicspacedata/query/class/tle_latest/ORDINAL/1/EPOCH/%3Enow-30/orderby/NORAD_CAT_ID/format/json
+
+Once you have the latest data, then update `public/data/TLE.json`, if running in
+development or `data/TLE.json` if deployed.
+
+## License
+
+MIT license

bin/fetch-tle.sh

@@ -0,0 +1,41 @@
+#!/bin/sh
+
+basepath=`dirname "$0"`
+cd "$basepath"
+
+identity=$SPACETRACK_IDENTITY
+password=$SPACETRACK_PASSWORD
+
+if [ -z "$SPACETRACK_IDENTITY" ] || [ -z "$SPACETRACK_PASSWORD" ]
+then
+  echo 'ensure both "SPACETRACK_IDENTITY" and "SPACETRACK_PASSWORD" are set'
+  exit
+fi
+
+auth_url="https://www.space-track.org/ajaxauth/login"
+source_url="https://www.space-track.org/basicspacedata/query/class/tle_latest/ORDINAL/1/EPOCH/%3Enow-30/orderby/NORAD_CAT_ID/format/json"
+tle_file="../public/data/TLE.json"
+output_file="../public/data/attributed-TLE.json"
+current_date=`date -u +"%Y-%m-%dT%H:%M:%SZ"`
+cookie_jar="/tmp/$USER-cookiejar"
+
+echo "Authenticating"
+curl -c $cookie_jar -b $cookie_jar "$auth_url" \
+   -d "identity=$identity&password=$password"
+
+echo "Downloading TLE data"
+
+curl --limit-rate 200K -cookie $cookie_jar -b $cookie_jar  "${source_url}" > $tle_file
+
+echo "Generating Attributed TLE file"
+echo "{
+  \"source\": {
+    \"name\": \"Space-Track.org\",
+    \"url\": \"https://www.space-track.org/\"
+  },
+  \"date\": \"$current_date\",
+  \"data\":
+" > $output_file
+
+cat $tle_file >> $output_file
+echo "\n}\n" >> $output_file

bin/generate-appinfo.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+
+build_date=`date -u +"%Y-%m-%dT%H:%M:%SZ"`
+mode="unknown"
+method="unknown"
+
+if [ "$GITHUB_REF_TYPE" == "tag" ]; then
+    ## GitHub Tag
+    version="$GITHUB_REF"
+    git_hash="$GITHUB_SHA"
+    git_branch="$GITHUB_REF"
+    mode="tag"
+    method="github-tag"
+elif [ -n "GITHUB_SHA"]; then
+    ## GitHub Ref
+    version="$GITHUB_SHA"
+    git_hash="$GITHUB_SHA"
+    git_branch="$GITHUB_REF"
+    mode="ref"
+    method="github-ref"
+elif [ -n "$CI_COMMIT_TAG" ]; then
+    ## GitLab Tag
+    version="$CI_COMMIT_TAG"
+    git_hash="$CI_COMMIT_SHA"
+    git_branch="$CI_COMMIT_BRANCH"
+    mode="tag"
+    method="gitlab-ref"
+elif [ -n "$CI_COMMIT_REF_NAME" ]; then
+    ## GitLab Ref
+    version="$CI_COMMIT_SHA"
+    git_hash="$CI_COMMIT_SHA"
+    git_branch="$CI_COMMIT_BRANCH"
+    mode="ref"
+    method="gitlab-ref"
+elif command -v git &> /dev/null; then
+    #version=`git describe --tags --abbrev=0`
+    version=`git rev-parse --short HEAD`
+    git_hash=`git rev-parse HEAD`
+    git_branch=`git branch --show-current`
+    mode="cmd"
+    method="default"
+fi
+
+echo "APPINFO buildDate ..... $build_date"
+echo "APPINFO version ....... $version"
+echo "APPINFO gitHash ....... $git_hash"
+echo "APPINFO gitBranch ..... $git_branch"
+echo "APPINFO method ........ $method"
+json=$(cat <<EOF
+{
+    "buildDate": "$build_date",
+    "version": "$version",
+    "gitHash": "$git_hash",
+    "gitBranch": "$git_branch",
+    "mode": "$mode"
+}
+EOF
+)
+
+echo "$json" > "$1"
+