Skip to content

Commit 89113e5

Browse files
committed
feat: revert making fais-node optional as it's needed for tests
1 parent 1cf8287 commit 89113e5

File tree

3 files changed

+7
-18
lines changed

3 files changed

+7
-18
lines changed

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To work on the project, you need to install [NodeJS and NPM](https://nodejs.org/
1313
for your operating system.
1414

1515
_**Note:** If you'd like to make use of RAG (optional), you'll also need to ensure that [CMake](http://cmake.org)
16-
is installed. CMake is required for installing `faiss` which is pulled in by the optional depenency `faiss-node`._
16+
is installed. CMake is required for installing `faiss` which is pulled in by the dependency `faiss-node`._
1717

1818
Then, clone the project from GitHub. [Create a fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
1919
with your GitHub account, then enter the following in your command line
@@ -30,10 +30,6 @@ to install dependencies:
3030
npm ci
3131
```
3232

33-
_**Note:** If CMake is not available on the device, the optional dependency `faiss-node` will fail to install but
34-
will not prevent the application from installing. However, if you wish to use RAG, you'll need to install CMake and
35-
re-run `npm ci`._
36-
3733
## Development
3834

3935
### Start a Server
@@ -99,9 +95,9 @@ Follow these steps to complete a one-time setup to enable RAG in the system:
9995

10096
#### Troubleshooting
10197

102-
In order to use RAG, `fais-node` must be installed. `faise-node` is an optional dependency and requires that
103-
[CMake](https://cmake.org/) be installed on the machine first. If this has not been done, install CMake and re-run
104-
the application install steps.
98+
In order to use RAG, `fais-node` must be installed. `faise-node` requires that [CMake](https://cmake.org/)
99+
be installed on the machine first. If this has not been done, install CMake and re-run the application install
100+
steps.
105101

106102
### Lint
107103

package-lock.json

Lines changed: 2 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,13 @@
2828
"@xenova/transformers": "^2.17.2",
2929
"bliss-svg-builder": "^0.1.0-alpha.10",
3030
"express": "^4.19.2",
31+
"faiss-node": "^0.5.1",
3132
"htm": "^3.1.1",
3233
"ollama": "^0.5.8",
3334
"preact": "^10.23.2",
3435
"sass": "^1.77.8 ",
3536
"serve-static": "^1.15.0"
3637
},
37-
"optionalDependencies": {
38-
"faiss-node": "^0.5.1"
39-
},
4038
"devDependencies": {
4139
"@babel/preset-env": "^7.25.4",
4240
"@eslint/eslintrc": "^3.1.0",

0 commit comments

Comments
 (0)