@carto/do-catalog

Data Observatory Catalog

This repo contains sources (instructions atm) that build @carto/do-catalog NPM package

Quickstart

• [ ] Install nvm
• [ ] Execute nvm install && nvm use
• [ ] Execute npm install
• [ ] Execute ./scripts/checkout.sh

When to update

• Update is needed if cloud-native updates @deck.gl version as do-catalog shares runtime with cloud-native so require strictly same version of deck.gl compiled in
• Update is needed if cartodb releases new version of do-catalog app, one shall merge main into cloud-native branch then

Publishing updates

1. nvm use
2. rm -rf .cartodb && npm install && ./scripts/checkout.sh
3. npm version <patch | minor | major>
4. git push origin "v$(awk -F\" '/"version":/ {print $4}' package.json)"
5. Create a new release with the latest published tag
6. ./scripts/build.sh
7. npm login
8. npm publish --tag latest

NOTE: If you don't have access to the @carto/do-catalog package, you should ask for permissions raising an it-issue

Testing locally with cloud-native

IMPORTANT: This is a very hacky solution, yarn link should be used instead, but due to incompatibility issues with latest versions of Yarn, copying the umd.min.js file into cloud-native/workspace-www/node_modules is the quick-win:

1. Install all the dependencies in the cloud-native/workspace-www directory:

.../cloud-native/workspace-www$ yarn

2. Build the do-catalog package and replace it in cloud-native/workspace-www/node_modules:

.../do-catalog$ nvm use && npm run build
.../do-catalog$ ./scripts/copy-build.sh /route/to/cloud-native/workspace-www

3. Start the cloud-native Server

.../cloud-native/workspace-www$ yarn start --force

NOTE: Repeat Step 2 & 3 each time you modify the do-catalog under the .cartodb directory

Image assets

The bundle relies on image assets from .cartodb/public/assets/1.0.0-assets.274/images/do-catalog/ to be available under ../../images/do-catalog w.r.t to url from which javacript runtime is loaded.

Currently those images are committed as-is into cloud-native repo in public/images/do-catalog

IMPORTANT NOTES

• To install peerDependencies correctly you'll need to use Node v12 with npm v7 and run: npm install --force

TODO:

• Publish images in this npm package and
• cloud-native to bundle those images from npm package