Version 1.0

knguyen0125 · Sep 29, 2018 · e078139 · e078139
1 parent 0c7e17e
commit e078139
Show file tree

Hide file tree

Showing 25 changed files with 15,840 additions and 2,116 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -26,7 +26,10 @@ module.exports = {
     'no-multi-assign': 0,
 		'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
     'strict': 0,
-    'lines-between-class-members': 0
+		'lines-between-class-members': 0,
+    'linebreak-style': 0,
+    'class-methods-use-this': 0,
+    'prefer-arrow-callback': 0
 	},
 	settings: {
 		'import/core-modules': [ 

diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,10 @@
 .DS_Store
-dist/electron/*
-dist/web/*
+dist/*/*
 build/*
 !build/icons
 node_modules/
 npm-debug.log
 npm-debug.log.*
 thumbs.db
 !.gitkeep
+*.log
diff --git a/README.md b/README.md
@@ -1,11 +1,79 @@
-# Electron Vue Template
+# NFC-Electron Reader
 
-Uses Electron-Webpack, Electron Builder, Babel 7 and Vue
+Uses Electron-Webpack, Electron Builder, Babel 7 and Vue, internally powered by nfc-pcsc
+
+# Yarn
+
+- Electron Builder recommends using `Yarn` to build. When using Yarn, the lock file is used and guaranteed to download the correct version for the working build. There is no such guarantee for `npm`
+
+- To install `yarn`: 
+
+```
+npm install -g yarn
+```
+
+- Switching to `yarn`: Remove `node_modules/` folder and then run 
+
+```
+yarn
+```
+
+- To build with `yarn`, run:
+
+```
+yarn build
+```
+
+## Build Process
+
+- To build:
+
+```
+npm run build
+
+or
+
+yarn build
+```
+
+- Note: Currently, it does not clean previous builds before building. Most of the time it would be fine, but if it does not build, remove all files and folders inside `dist/` and `build/` folders. DO NOT REMOVE `build/icons/` folder.
+
+### Special Note for Windows
+- This reader programs rely on node native module, which means it need to be recompiled before it can run. In windows, it can be difficult to set up environment
+  - See [node-gyp](https://github.com/nodejs/node-gyp) for more details
+
+- In Windows: `node-gyp` and `windows-build-tools` are required. In an ELEVATED PowerShell, run:
+
+```
+npm install -g node-gyp windows-build-tools
+```
+
+- After install, reboot
+- Change directory and run:
+
+```
+npm install
+npm run rebuild
+```
+
+or 
+
+```
+yarn
+yarn build
+```
+
+## Brief Explanation
+- Main Process: Controls communication with NFC Device.
+- Renderer Process: Reader/Writer Interface
+
+- Communication between Main and Renderer process: Via Electron IPC. Read/Write/Write-Readonly permissions as well as messages are set through ipc messages
+  - Read [ipcRenderer](https://electronjs.org/docs/api/ipc-renderer) and [ipcMain](https://electronjs.org/docs/api/ipc-main)
 
 ## Known Issues
 
 ### Babel Plugins
 
 Due to how `electron-webpack` creates `babel-loader` for `webpack`, some plugins cannot be configured if installed as devDependencies.
 
-If you wishes to configure Babel plugins, install plugins as dependencies.
+If you wishes to configure these Babel plugins, install plugins as dependencies.
diff --git a/build/icons/icon.icns b/build/icons/icon.icns
diff --git a/build/icons/icon.ico b/build/icons/icon.ico
diff --git a/build/icons/icon.png b/build/icons/icon.png
diff --git a/dist/.gitkeep b/dist/.gitkeep
diff --git a/dist/.renderer-index-template.html b/dist/.renderer-index-template.html
@@ -2,9 +2,9 @@
 <html>
   <head>
     <meta charset="utf-8">
-
+    <title>NFC Tools</title>
     <script>
-      require("module").globalPaths.push("/home/kevin/Work/nfc-electron/node_modules")
+
       require("source-map-support/source-map-support.js").install()
     </script>