Skip to content

Commit ffecb2d

Browse files
authored
minimal dev docs (#35)
* pin volta versions * minimal dev docs
1 parent 8af51c3 commit ffecb2d

File tree

2 files changed

+31
-3
lines changed

2 files changed

+31
-3
lines changed

DEVELOP.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Developer Documentation
2+
3+
This project uses [Volta](https://volta.sh/) to manage the JavaScript toolchain. After installing Volta, you should be able to just run
4+
5+
```
6+
npm install
7+
```
8+
9+
and Volta will automatically install the pinned versions of Node and NPM and install dependencies. If you need to change the pinned version of Node or NPM, you can do that in the `"volta"` section of `package.json`.
10+
11+
## Building/Bundling
12+
13+
First, let me state that JavaScript bundling is hard, so if you aren't able to use the generated bundle for some reason, open an issue or make a PR! It probably doesn't work out of ignorance, not intent.
14+
15+
This project uses `tsc` to generate ES-module JS code from the TypeScript source. It also uses rollup to generate other bundle formats.
16+
17+
After running `npm install`, you can run
18+
19+
```
20+
npm run build
21+
```
22+
23+
to perform both the tsc-based and rollup-based build steps. Or you can run `build:tsc` to run just `tsc` or `build:rollup` to run just rollup.
24+
25+
## Examples
26+
27+
It's hard to test deck.gl-based code (or at least involved to set up the test harness), so for now this project is primarily "tested through examples" :sweat_smile:. (In the future it would be nice to implement full testing).
28+
29+
The examples are not yet fully reproducible because they rely on specific data files whose generation is not 100% reproducible. This is planned work for the future.

package.json

+2-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333
"dist/",
3434
"src/"
3535
],
36-
"packageManager": "[email protected]",
3736
"repository": "https://github.com/geoarrow/deck.gl-geoarrow",
3837
"author": "Kyle Barron <[email protected]>",
3938
"license": "MIT",
@@ -60,7 +59,7 @@
6059
"@luma.gl/webgl": "^8.5.21"
6160
},
6261
"volta": {
63-
"node": "20.5.0",
64-
"yarn": "3.6.3"
62+
"node": "20.8.0",
63+
"npm": "10.2.0"
6564
}
6665
}

0 commit comments

Comments
 (0)