@@ -40,21 +40,19 @@ 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 (` docs ` ).
43
+ This is a monorepo containing npm workspaces for the library (` core ` ), the desktop app (` desktop-app ` ), and the website (` website ` ).
44
44
45
45
### Website
46
46
47
47
The website uses symlinks to reference the library (` core ` ) and shared resources (` images ` ) during development.
48
48
49
- When deploying with ` npm run deploy -w docs ` , the symlinks are dereferenced using ` cp -rL ` .
49
+ When deploying with ` npm run deploy -w website ` , the symlinks are dereferenced using ` cp -rL ` .
50
50
51
51
The website is deployed to GitHub Pages using the [ ` gh-pages ` ] ( https://www.npmjs.com/package/gh-pages ) npm package.
52
52
53
- GitHub Pages supports symlinks, but not to paths outside of ` docs ` when deploying ` docs ` as the site root, unfortunately,
53
+ ( GitHub Pages supports symlinks, but not to paths outside of ` docs ` when deploying ` docs ` as the site root, unfortunately,
54
54
hence I can't use symlinks to reference the library and avoid a deployment script, while keeping a clean repository structure.
55
- I would have to have the website files at the root of the repository, which I don't want.
56
-
57
- Since I'm using ` gh-pages ` , I no longer need to name the folder ` docs ` at least though... I can change it back to ` website ` ...
55
+ I would have to have the website files at the root of the repository.)
58
56
59
57
### Desktop App
60
58
@@ -104,7 +102,7 @@ MIT-licensed, see [LICENSE.txt](./LICENSE.txt)
104
102
- Open up a command prompt / terminal in the project directory.
105
103
- Run ` npm install `
106
104
- Run ` npm -w core install ` (` -w ` is short for ` --workspace ` , and can be used with many npm commands to target a workspace)
107
- - Run ` npm -w docs start ` to start a web server that will automatically reload when files change.
105
+ - Run ` npm -w website start ` to start a web server that will automatically reload when files change.
108
106
- For the electron app:
109
107
- Then `npm -w desktop-app install`
110
108
0 commit comments