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
## Description of changes
*Summarize the changes made by this PR.*
- Improvements & Bug fixes
- ...
- New functionality
- ...
## Test plan
*How are these changes tested?*
- [ ] Tests pass locally with `pytest` for python, `yarn test` for js,
`cargo test` for rust
## Documentation Changes
*Are all docstrings for user-facing APIs updated if required? Do we need
to make documentation changes in the [docs
repository](https://github.com/chroma-core/docs)?*
Copy file name to clipboardExpand all lines: clients/js/DEVELOP.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -19,24 +19,24 @@ environment:
19
19
20
20
To get started developing on the JS client libraries, you'll want to run the examples.
21
21
22
-
1.`yarn` to install deps.
23
-
1.`yarn build` to build the library.
22
+
1.`pnpm install` to install deps.
23
+
1.`pnpm build` to build the library.
24
24
1.`cd examples/browser` or `cd examples/node`
25
-
1.`yarn` to install example deps.
26
-
1.`yarn dev` to run the example.
25
+
1.`pnpm install` to install example deps.
26
+
1.`pnpm dev` to run the example.
27
27
28
28
### Generating REST Client Code
29
29
30
30
If you modify the REST API, you'll need to regenerate the generated code that underlies the JavaScript client libraries.
31
31
32
-
1.`yarn` to install deps
33
-
2.`yarn genapi`
34
-
3. Examples are in the `examples` folder. There is one for the browser and one for node. Run them with `yarn dev`, eg `cd examples/browser && yarn dev`
32
+
1.`pnpm install` to install deps
33
+
2.`pnpm genapi`
34
+
3. Examples are in the `examples` folder. There is one for the browser and one for node. Run them with `pnpm dev`, eg `cd examples/browser && pnpm dev`
35
35
36
36
### Running tests
37
37
38
-
`yarn test` will launch a test docker backend, run a db cleanup and run tests.
39
-
`yarn test:run` will run against the docker backend you have running. But CAUTION, it will delete data. This is the easiest and fastest way to run tests.
38
+
`pnpm test` will launch a test docker backend, run a db cleanup and run tests.
39
+
`pnpm test:run` will run against the docker backend you have running. But CAUTION, it will delete data. This is the easiest and fastest way to run tests.
`npm run release` pushes the `package.json` defined packaged to the package manager for authenticated users. It will build, test, and then publish the new version.
79
+
`pnpm run release` pushes the `package.json` defined packaged to the package manager for authenticated users. It will build, test, and then publish the new version.
0 commit comments