Skip to content

Commit 96ba4b2

Browse files
authored
Update README-dev.md
Updated for v.14 launch.
1 parent 47db31e commit 96ba4b2

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

README-dev.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,25 @@
44

55
**Windows Developers**: Install Node.js globally, may also have to run Spearmint in admin mode.
66

7-
As of January 2023, spearmint works with node version 19.4.0 electron-devtools-vendor must be at version 1.1 for now due to a bug.
7+
## Procedure for working on the project as a Windows user.
8+
9+
1. Download VcXsrv or a similar program in order to run an X environment on Windows. [VcXsrv](https://sourceforge.net/projects/vcxsrv/)
10+
2. Configure XLaunch properly:
11+
3. On the first settings screen on launch, select the following settings:
12+
- Multiple windows
13+
- Display number: -1
14+
4. On the second page select the “Start no client” option
15+
5. On the third setting screen select the following options:
16+
- Clipboard
17+
- Primary Selection
18+
- Native opengl
19+
- Under “Additional Parameters” textbox write ‘-ac’ (no quotes)
20+
21+
Completing these steps after installing will launch XLaunch and enable you to run Spearmint in the Windows desktop environment.
22+
23+
# Initial Setup
24+
25+
As of January 2023, spearmint works with node version 20.1.0.
826
React must be version 17 due to a dependency for mui. Fix-path must be version 3.0.0 due to 4.0.0 only being usable with an import statement, which is not supported in electron.jsx.
927

1028
1. Fork and clone this repository.
@@ -32,22 +50,14 @@ React must be version 17 due to a dependency for mui. Fix-path must be version 3
3250

3351
# Tips for development mode
3452

35-
- To enable hot-module reloading, uncomment line 23 in the electron.jsx file.
53+
- To enable hot-module reloading, uncomment line 22 in the electron.jsx file.
3654

3755
// require('electron-reloader')(module);
3856

39-
- To enable Chrome Dev Tools, uncomment line 71 in the electron.jsx file:
57+
- To enable Chrome Dev Tools, uncomment line 70 in the electron.jsx file:
4058

4159
// mainWindow.webContents.openDevTools();
4260

43-
- To enable React Dev Tools, uncomment lines 285 to 289 in the electron.jsx file:
44-
45-
// .then(() => {
46-
// session.defaultSession.loadExtension(REACT_DEVELOPER_TOOLS, { allowFileAccess: true })
47-
// .then((name) => console.log(`Added Extension: ${name}`))
48-
// .catch((err) => console.log(`An error occurred adding an extension: ${err}`));
49-
// })
50-
5161
# Suggestions if you would like contriubute:
5262

5363
1. Exporting test files in TypeScript: the tests currently export in JS.
@@ -60,10 +70,16 @@ React must be version 17 due to a dependency for mui. Fix-path must be version 3
6070

6171
5. GitHub OAuth is functional, but Google OAuth is currently broken. If you are planning to persist user data, this is an excellent feature to resolve.
6272

63-
6. Add more customization to the tests themseleves such as chaining expects, add the ability to use siblings and children, etc., or having the ability to test more than one component in one test file.
73+
6. Add more customization to the tests themselves such as chaining expects, add the ability to use siblings and children, etc., or having the ability to test more than one component in one test file.
6474

6575
7. Some of test cases needs improvement on UI as they do not have any styling or optimal user experience
6676

77+
8. Continue to improve internal testing coverage – while it has been greatly expanded there are many parts of the internals of the application that are still not being tested, and especially with regards to integration and end to end testing, more could be done.
78+
79+
9. Consider removing MUI framework as it is incompatible with React v18+ and no longer being actively updated - either replacing with another frontend framework or styling via CSS.
80+
81+
10. Consider implementing React Dev Tools in the app.
82+
6783
**_Please feel free to add any other features or fixes that you would like or are interested in._**
6884

6985
# Build and Run image on Docker

0 commit comments

Comments
 (0)