Initial setup

.eslintrc.yml

@@ -0,0 +1,4 @@
+extends: airbnb-base
+rules:
+  no-console:
+    - off

.gitignore

@@ -1,61 +1,49 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
 # Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
 # Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
+# Coverage directory used by tools like istanbul
 # Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
+# Directory for instrumented libs generated by jscoverage/JSCover
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+# Logs
 # Optional REPL history
-.node_repl_history
-
+# Optional eslint cache
+# Optional npm cache directory
 # Output of 'npm pack'
-*.tgz
-
+# Runtime data
+# TypeScript v1 declaration files
 # Yarn Integrity file
-.yarn-integrity
-
 # dotenv environment variables file
-.env
-
 # next.js build output
+# node-waf configuration
+# nyc test coverage
+*.log
+*.pid
+*.pid.lock
+*.seed
+*.tgz
+.DS_Store
+.env
+.eslintcache
+.grunt
+.lock-wscript
 .next
+.node_repl_history
+.npm
+.nyc_output
+.tox/
+.vscode/
+.yarn-integrity
+bower_components
+build/Release
+coverage
+jspm_packages/
+lib-cov
+logs
+node_modules/
+npm-debug.log*
+out/
+pids
+typings/
+virtualenv_run/
+yarn-debug.log*
+yarn-error.log*

.htmllintrc

@@ -0,0 +1,72 @@
+{
+    "plugins": [],  // npm modules to load
+
+    "maxerr": false,
+    "raw-ignore-regex": false,
+    "attr-bans": [
+        "align",
+        "background",
+        "bgcolor",
+        "border",
+        "frameborder",
+        "longdesc",
+        "marginwidth",
+        "marginheight",
+        "scrolling",
+        "style",
+        "width"
+    ],
+    "indent-delta": false,
+    "indent-style": "nonmixed",
+    "indent-width": 4,
+    "indent-width-cont": false,
+    "spec-char-escape": true,
+    "text-ignore-regex": false,
+    "tag-bans": [
+        "style",
+        "b",
+        "i"
+    ],
+    "tag-close": true,
+    "tag-name-lowercase": true,
+    "tag-name-match": true,
+    "tag-self-close": false,
+    "doctype-first": false,
+    "doctype-html5": false,
+    "attr-name-style": "dash",
+    "attr-name-ignore-regex": false,
+    "attr-no-dup": true,
+    "attr-no-unsafe-char": true,
+    "attr-order": false,
+    "attr-quote-style": "double",
+    "attr-req-value": true,
+    "attr-new-line": false,
+    "attr-validate": true,
+    "id-no-dup": true,
+    "id-class-no-ad": true,
+    "id-class-style": "underscore",
+    "class-no-dup": true,
+    "class-style": false,
+    "id-class-ignore-regex": false,
+    "img-req-alt": true,
+    "img-req-src": true,
+    "html-valid-content-model": true,
+    "head-valid-content-model": true,
+    "href-style": false,
+    "label-req-for": true,
+    "line-end-style": "lf",
+    "line-no-trailing-whitespace": false,
+    "line-max-len": false,
+    "line-max-len-ignore-regex": false,
+    "head-req-title": true,
+    "title-no-dup": true,
+    "title-max-len": 60,
+    "html-req-lang": false,
+    "lang-style": "case",
+    "fig-req-figcaption": false,
+    "focusable-tabindex-style": false,
+    "input-radio-req-name": true,
+    "input-req-label": false,
+    "table-req-caption": false,
+    "table-req-header": false
+}

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v1.4.0
+    hooks:
+    -   id: check-json
+    -   id: check-merge-conflict
+    -   id: check-symlinks
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: file-contents-sorter
+        files: .gitignore
+    -   id: mixed-line-ending
+    -   id: pretty-format-json
+        args: [--autofix]
+    - id: trailing-whitespace
+-   repo: https://github.com/Lucas-C/pre-commit-hooks-nodejs
+    sha: v1.1.0
+    hooks:
+    -   id: markdown-toc
+    -   id: htmlhint
+    -   id: htmllint
+-   repo: https://github.com/pre-commit/mirrors-eslint
+    rev: v5.9.0  # Use the sha / tag you want to point at
+    hooks:
+    -   id: eslint
+        additional_dependencies:
+        -   eslint@^4.19.1
+        -   [email protected]
+        -   [email protected]

README.md

@@ -1,2 +1,10 @@
 # MonkeyPath
-A spline generator for monkeys
+A spline generator for monkeys.
+
+## Development
+This project requires [Node.js](https://nodejs.org), [electron-forge](https://electronforge.io/), python. First, run `npm install`. Next, run `pip install -r requirements-dev-minimal.txt`. Then, run `npm run tox` which will install the pre-commit hooks, as well as run the hooks.
+
+To run unit tests and pre-commit hooks, run `npm test`. To just run pre-commit hooks, run `npm run tox`. To start the application, run `npm start`. To package the application and make a distributable application, run `npm run make`. For this last command, electron-forge is required.
+
+## Windows Users
+On windows, node and npm will need to be installed natively, not just in the WSL. Go ahead and install Nodejs for windows from the link above. Then, to make sure `npm` is up to date, run ` npm install -i npm -g` in the Command Prompt. Change to the project directory, and run `npm install` to install the windows specific node packages. After this, bash may be used for everything else. All the same commands as stated above will work, except for `npm make`. Right now, this only seems to work in the Command Prompt AND if the directory `virtualenv_run` is deleted.