Skip to content

Commit

Permalink
Update SETUP_DEV_ENVIRONMENT.md (#102)
Browse files Browse the repository at this point in the history
  • Loading branch information
markwaddle authored Oct 8, 2024
1 parent ddf9733 commit 189a183
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 34 deletions.
10 changes: 7 additions & 3 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,15 @@
"**/.data/**",
"**/__pycache__/**"
],
"python.analysis.fixAll": ["source.unusedImports"],
"python.analysis.fixAll": [
"source.unusedImports"
],
"python.analysis.inlayHints.functionReturnTypes": true,
"python.analysis.typeCheckingMode": "basic",
"python.defaultInterpreterPath": "${workspaceFolder}/workbench-service/.venv",
"python.languageServer": "Pylance",
"python.testing.pytestEnabled": true,
"python.testing.cwd": "${workspaceFolder:v1}/workbench-service",
"python.testing.cwd": "${workspaceFolder}/workbench-service",
"python.testing.pytestArgs": [],
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff",
Expand All @@ -56,7 +58,9 @@
"source.fixAll": "explicit"
}
},
"css.lint.validProperties": ["composes"],
"css.lint.validProperties": [
"composes"
],
"editor.defaultFormatter": "esbenp.prettier-vscode",
"eslint.lintTask.enable": true,
"editor.formatOnPaste": true,
Expand Down
35 changes: 4 additions & 31 deletions docs/SETUP_DEV_ENVIRONMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,37 +73,10 @@ If you haven't already, enable long file paths on Windows.
- Find the `LongPathsEnabled` key. If it doesn’t exist, right-click on the `FileSystem` key, select `New > DWORD (32-bit) Value`, and name it `LongPathsEnabled`.
- Double-click on `LongPathsEnabled`, set its value to `1`, and click OK.

### Configure and build the backend
# Install and run the backend

# Frontend Setup
See [workbench-service/README.md](../workbench-service/README.md)

The frontend for the Semantic Workbench is written in [Node 20](https://nodejs.org/en/download).
# Install and run the frontend

Linux ([latest instructions](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating)):

curl -o- https://github.com/raw/nvm-sh/nvm/v0.40.1/install.sh | bash

macOS:

brew install nvm

Windows:

winget install CoreyButler.NVMforWindows

Once you have nvm installed:

```
nvm install 20 lts
nvm use 20
npm install -g pnpm
```

### Build the frontend

Within the [`v1/app`](../workbench-app/) directory, install packages.

```
cd workbench-app
make
```
See [workbench-app/README.md](../workbench-app/README.md)

0 comments on commit 189a183

Please sign in to comment.