You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-7Lines changed: 10 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -40,13 +40,16 @@ To test the Eye Gaze Mode properly, I needed a facial mouse, but eye trackers ar
40
40
41
41
## Software Architecture
42
42
43
-
This is a monorepo containing npm workspaces for the library (`core`), the desktop app (`desktop-app`), and the website (`website`).
43
+
This is a monorepo containing packages for the library (`core`), the desktop app (`desktop-app`), and the website (`website`).
44
+
45
+
46
+
I tried npm workspaces, but it doesn't work with Electron Forge packaging. See [electron/forge#2306](https://github.com/electron/forge/issues/2306).
44
47
45
48
### Website
46
49
47
50
The website uses symlinks to reference the library (`core`) and shared resources (`images`) during development.
48
51
49
-
When deploying with `npm run deploy -w website`, the symlinks are dereferenced using `cp -rL`.
52
+
When deploying with `npm run website:npm -- run deploy`, the symlinks are dereferenced using `cp -rL`.
50
53
51
54
The website is deployed to GitHub Pages using the [`gh-pages`](https://www.npmjs.com/package/gh-pages) npm package.
52
55
@@ -100,11 +103,11 @@ MIT-licensed, see [LICENSE.txt](./LICENSE.txt)
100
103
-[Clone the repo.](https://help.github.com/articles/cloning-a-repository/)
101
104
- Install [Node.js](https://nodejs.org/) if you don't have it
102
105
- Open up a command prompt / terminal in the project directory.
103
-
- Run `npm install`
104
-
- Run `npm -w core install`(`-w` is short for `--workspace`, and can be used with many npm commands to target a workspace)
105
-
- Run `npm -w website start` to start a web server that will automatically reload when files change.
106
+
- Run `npm install` to install project-wide dependencies.
107
+
- Run `npm run website:npm -- install`to install the website's dependencies. (`--` allows passing arguments to the script, which is just a simple wrapper to run `npm` within the directory of the package.)
108
+
- Run `npm run website` to start a web server that will automatically reload when files change.
106
109
- For the electron app:
107
-
- Then `npm -w desktop-app install`
110
+
- Run`npm run desktop-app:npm -- install`
108
111
109
112
### VS Code
110
113
@@ -121,7 +124,7 @@ The app is not yet distributed as precompiled binaries.
121
124
If you want to try out the desktop app in the meantime:
0 commit comments