Init commit

Author: d-w-d

.editorconfig

@@ -0,0 +1,14 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 100
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

.env-template

@@ -0,0 +1,14 @@
+# Settings for github client deployment
+GITHUB_USER_NAME='dwd-umd'
+GITHUB_REPO_NAME='sbn-portal-site'
+# Variables injected into client code by webpack
+SITE_LONG_TITLE='My Cool Site'
+SITE_SHORT_TITLE='My Site'
+# Ports
+CLIENT_DEV_PORT=3000
+SERVER_DEV_PORT=5000
+# Misc
+JWT_SECRET=BeSureToChangeThis
+SOLR_VERSION=8.2.0
+API_BASE_PATH=/
+REMOTE_BASE_HREF='/sbn-portal-site/'

.gitignore

@@ -0,0 +1,46 @@
+# Misc
+.redundant
+redundant
+**/node_modules/**/*
+**/.DS_Store
+.env
+.solr/**
+coverage
+tempSolr
+
+# compiled output
+/dist
+/dist-client
+/dist-server
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json

.jest.config.js

@@ -0,0 +1,34 @@
+module.exports = {
+  collectCoverage: true,
+  coverageDirectory: '../coverage',
+  moduleFileExtensions: ['js', 'json', 'ts', 'tsx'],
+  moduleDirectories: ['node_modules'],
+  rootDir: __dirname,
+  testEnvironment: 'jest-environment-jsdom-fourteen',
+  testRegex: '.spec.*$',
+  transform: {
+    '.*.ts.?$': 'ts-jest'
+  },
+  globals: {
+    'ts-jest': {
+      tsConfig: 'src/client/tsconfig.test.json'
+    },
+    __BASE_HREF__: process.env.BASE_HREF || '/',
+    __SITE_SHORT_TITLE__: process.env.SITE_SHORT_TITLE || 'Test Short Title',
+    __SITE_LONG_TITLE__: process.env.SITE_LONG_TITLE || 'Test Long Title'
+  },
+  moduleNameMapper: {
+    '\\.(css|less|scss)$': '<rootDir>/__mocks__/styleMock.js',
+    '\\.(gif|ttf|eot|svg)$': '<rootDir>/__mocks__/fileMock.js',
+
+    // These must correspond to compilerOptions.paths in src/client/tsconfig.json
+    '^@client(.*)$': '<rootDir>/src/client/$1',
+    '^@components(.*)$': '<rootDir>/src/client/components/$1',
+    '^@common(.*)$': '<rootDir>/src/common/$1',
+    '^@server(.*)$': '<rootDir>/src/server/$1'
+  },
+  // Follows: https://www.npmjs.com/package/jest-fetch-mock
+  automock: false,
+  setupFiles: ['./src/client/setupJest.ts'],
+  testURL: 'https://www.something.com/'
+};

.prettierignore

@@ -0,0 +1,2 @@
+package.json
+package-lock.json

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "printWidth": 100,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "semi": true
+}

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "chrome",
+            "request": "launch",
+            "name": "Launch Chrome against localhost",
+            "url": "http://localhost:3000",
+            "webRoot": "${workspaceFolder}"
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,35 @@
+{
+  "typescript.tsdk": "./node_modules/typescript/lib",
+
+  "files.associations": {
+    "*.html": "html"
+  },
+
+  "[html]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.tabSize": 4
+  },
+
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+
+  "[jsonc]": {
+    "editor.formatOnSave": false,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+
+  "[scss]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+
+  "tslint.configFile": "tslint.json",
+
+  "tslint.enable": true,
+
+  "cSpell.ignoreWords": ["ssot"]
+}

README.md

@@ -0,0 +1,50 @@
+# Portal Site Boilerplate
+
+## What's This?
+
+Starter project with the essential infrastructure for a full-stack web app using:
+
+- Typescript
+- React
+  - Hooks
+  - MaterialUI
+  - Webpack
+  - ...
+- Express
+  - Swagger
+  - ...
+
+## How to Operate
+
+Almost everything you need to operate this codebase is put into an executable bash script. These scripts always begin with '\_'.
+
+## Quick Start
+
+- Make sure you have node/npm installed
+
+  - I recommend you use the [nvm](https://github.com/nvm-sh/nvm) tool to install/activate different versions of node/npm on your system
+    To install nvm, run: `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.0/install.sh | bash`
+    - Note: we'll be using node version 10
+    - Basic usage of nvm to install and activate node v10:
+      - `nvm install 10`
+      - `nvm use 10`
+
+- Clone the codebase to a directory on your machine: `git clone https://github.com/dwd-umd/sbn-portal-site.git .`
+- Copy `.env-template` to `.env`
+- Install node packages: `npm install`
+- Start frontend: `./_client_manager`
+- In separate tab, start server: `./_server_manager`
+- Visit `http://localhost:3000` in your browser
+
+## Code Organization
+
+...
+
+## TODOs
+
+- Add e2e testing
+- Setup Jenkins CI
+- Purge unused packages
+- SEO / SSR
+- Add local-storage-tracked dark/light theme settings
+- Add email service to backend

__mocks__/fileMock.js

@@ -0,0 +1 @@
+module.exports = 'test-file-stub';