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
chore: tiny documentation updates and fix docker compose version warning (#1808)
- Updates documentation to reflect that we no longer encourage WSL development.
- Updated references to Node 22 and PHP 7.4
- Removed the docker compose version from the yml file because that was causing a warning message.
Copy file name to clipboardExpand all lines: docs/DEVELOPER.md
+3-6Lines changed: 3 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -30,15 +30,13 @@ Welcome! We're glad that you are interested in helping develop Language Forge.
30
30
31
31
### Supported Development Environments
32
32
33
-
Development of Language Forge is supported using [VS Code](https://code.visualstudio.com/download) on Linux, MacOS or Windows using WSL ([`wsl --install`](https://learn.microsoft.com/en-us/windows/wsl/install)).
34
-
35
-
On Windows, the project should be opened with the [Remote - WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) VS Code extension, so that all commands and extensions run on WSL.
33
+
Development of Language Forge is supported using [VS Code](https://code.visualstudio.com/download) on Linux, MacOS or Windows
36
34
37
35
### IDE Developer Experience (DX)
38
36
39
37
While Docker is great way to encapsulate all of the dependencies, build tools and run-time environment of the application, IDEs usually require locally installed extensions, tools and runtimes in order to provide type checking, code hints, and debugging capabilities that make for a better developer experience. To this end, the following locally installed tools/dependencies may be installed for good DX:
40
38
41
-
- PHP 7.3
39
+
- PHP 7.4
42
40
- Composer
43
41
- Node and npm
44
42
- .Net SDK
@@ -52,9 +50,8 @@ While Docker is great way to encapsulate all of the dependencies, build tools an
52
50
2. Permit your user (and not just "sudo") to contact the Docker daemon: `sudo usermod -aG docker yourUsername && sudo chmod 666 /var/run/docker.sock`.
53
51
3. (Optional) Configure docker to start on boot: `printf '[boot]\ncommand="service docker start"\n' | sudo tee /etc/wsl.conf` (assuming `/etc/wsl.conf` is currently unused).
3. Install [Node 16.14.0](https://nodejs.org/en/download/). We recommend using [nvm](https://github.com/nvm-sh/nvm#installation-and-update).
53
+
3. Install [Node 22](https://nodejs.org/en/download/). We recommend using [nvm](https://github.com/nvm-sh/nvm#installation-and-update) or [nvm on Windows](https://github.com/coreybutler/nvm-windows).
56
54
4. Clone the repo: `git clone https://github.com/sillsdev/web-languageforge`.
57
-
1. Windows users, be sure to clone the project to the WSL file system (to keep VS Code, Git and the file system in sync)
58
55
5. Run `npm install` (required for git pre-commit hook with Prettier)
0 commit comments