Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: tiny documentation updates and fix docker compose version warning #1808

Merged
merged 4 commits into from
May 7, 2024
Merged

chore: tiny documentation updates and fix docker compose version warning #1808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
11018f0
remove obsolete docker compose version
megahirt May 2, 2024
baaecc3
update DEVELOPER docs PHP 7.4 ref
megahirt May 2, 2024
db15655
remove WSL recommendation
megahirt May 2, 2024
0e767e2
update docs to node 22
megahirt May 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# https://docs.docker.com/compose/compose-file
# https://github.com/compose-spec/compose-spec/blob/master/spec.md
version: '3.5'

# networks:
# lexbox:
Expand Down
9 changes: 3 additions & 6 deletions docs/DEVELOPER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,13 @@ Welcome! We're glad that you are interested in helping develop Language Forge.

### Supported Development Environments

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)).

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.
Development of Language Forge is supported using [VS Code](https://code.visualstudio.com/download) on Linux, MacOS or Windows

### IDE Developer Experience (DX)

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:

- PHP 7.3
- PHP 7.4
- Composer
- Node and npm
- .Net SDK
Expand All @@ -52,9 +50,8 @@ While Docker is great way to encapsulate all of the dependencies, build tools an
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`.
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).
2. Install [Make](https://www.gnu.org/software/make/): `sudo apt install make`.
3. Install [Node 16.14.0](https://nodejs.org/en/download/). We recommend using [nvm](https://github.com/nvm-sh/nvm#installation-and-update).
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).
4. Clone the repo: `git clone https://github.com/sillsdev/web-languageforge`.
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)
5. Run `npm install` (required for git pre-commit hook with Prettier)

### Running the App Locally
Expand Down
Loading