refactor(global): cleanup, more comments

Author: saucesteals

Diff for: .config/forge.config.js

@@ -73,7 +73,7 @@ module.exports = {
           entryPoints: [
             {
               html: "./src/render/index.html",
-              js: "./src/render/renderer.ts",
+              js: "./src/renderer.ts",
               name: "main_window",
               preload: {
                 js: "./src/preload.ts",

Diff for: .config/webpack.main.config.js

@@ -5,7 +5,7 @@ module.exports = {
    * This is the main entry point for your application, it's the first file
    * that runs in the main process.
    */
-  entry: "./src/index.ts",
+  entry: "./src/main.ts",
   // Put your normal webpack config below here
 
   module: {

Diff for: README.md

@@ -120,16 +120,16 @@ yarn create-icons
 
     - Routes.tsx # react-router routes
 
-    - renderer.ts # main electron renderer entry
-
     - App.tsx # Export entire app with routes components 
               # and redux provider if you are using it
 
     - 
 
-  index.ts # main electron entry
+  main.ts # main "backend" electron entry
+
+  renderer.ts # main "frontend" electron renderer entry
 
-  preload.ts # electron preload
+  preload.ts # main "entry to frontend" electron preload entry
 
 ```
 

Diff for: src/app/ipc/main.ts

@@ -22,4 +22,4 @@ ipcMain.on("relaunch-app", () => {
 });
 
 // In this file you can include the rest of your app's specific main process
-// code. You can also put them in separate files and import them in index.ts.
+// code. You can also put them in separate files and import them in main.ts.

Diff for: src/index.ts renamed to src/main.ts

@@ -1,3 +1,12 @@
+/**
+ * This file will automatically be loaded by electron and run in the "main" context.
+ * This is your "backend"
+ * To learn more about the differences between the "main" and the "renderer" context in
+ * Electron, visit:
+ *
+ * https://electronjs.org/docs/tutorial/application-architecture#main-and-renderer-processes
+ */
+
 import { app, BrowserWindow } from "electron";
 import isDev from "electron-is-dev";
 import Store from "electron-persist-secure/lib/store";

Diff for: src/preload.ts

@@ -1 +1,10 @@
-import '../bridges/index';
+/**
+ * This file will automatically be loaded by electron and run in the "preload-scripts" context with Node.js API access (even though its in the renderer).
+ * This is your "priveleged entry to frontend"
+ * To learn more about the differences between the "preload-scripts" and the "renderer" context in
+ * Electron, visit:
+ *
+ * https://www.electronjs.org/docs/tutorial/process-model#preload-scripts
+ */
+
+import "../bridges/index";

Diff for: src/render/redux/index.ts

@@ -28,7 +28,7 @@ const persistConfig = {
 const persistedReducer = persistReducer(
   persistConfig,
   combineReducers({
-    count: countReducer,
+    counter: countReducer,
     char: charReducer,
   })
 );

Diff for: src/render/renderer.ts renamed to src/renderer.ts

@@ -1,14 +1,15 @@
 /**
- * This file will automatically be loaded by webpack and run in the "renderer" context.
+ * This file will automatically be loaded by electron and run in the "renderer" context with no access to Node.js APIs (except thru the contextBridge).
+ * This is your "frontend"
  * To learn more about the differences between the "main" and the "renderer" context in
  * Electron, visit:
  *
  * https://electronjs.org/docs/tutorial/application-architecture#main-and-renderer-processes
  */
 
 import ReactDOM from "react-dom";
-import App from "./App";
-import "./index.css";
+import App from "./render/App";
+import "./render/index.css";
 
 function render() {
   ReactDOM.render(App(), document.getElementById("root"));