dp-table-builder-ui

Starting the dev server

To run dp-table-builder-ui you must have:

1. nvm installed:

   brew install nvm

   :warning: Make sure to follow the instructions provided at the end of the install to configure up your shell profile.

2. The node version specified in .nvmrc installed through nvm:

   nvm install

Once you have installed those dependencies and cloned this repo you need to run the following:

1. Move into the correct directory

   cd dp-table-builder-ui

2. Build node modules (you won't need to do this everytime only when the assets need to be rebuilt)

   make node-modules

3. Run the server

   make debug

4. Open http://localhost:8080

Available Commands

• make audit- Runs audit check
• make build - Builds into npm package
• make debug - Runs dev server
• make lint - Runs lint checks
• make test - Runs tests
• make node-modules - Builds dependencies
• make clean Deletes built assets
• make help - Show help page for list of make targets

Releasing

This package is published to npm at npmjs.com/package/dp-table-builder-ui.

To release a new version:

1. Bump the version field in package.json following the ONS versioning guide
2. Run npm install to update package-lock.json
3. Commit, raise a PR and merge to main - NB. DO NOT PUSH THE MERGED PR UP TO GITHUB UNTIL AFTER TAGGING IT (SEE NEXT STEP)
4. Tag the merged commit, and push up the merge using --follow-tags, as explained in the ONS tagging guide
5. The CI pipeline publishes the package to npm on the tagged commit

Dependencies

• No further dependencies other than those defined in package.json

Troubleshooting

Error saying python2 not found in path for macOS users

Solution You will need to install python2

As other services use Python3, it is advised to use pyenv to manage the python versions There is a .python-version file that will set the python version locally

1. brew install pyenv
2. if running on macOS 10.9 > then run brew install zlib; CPPFLAGS="-I$(brew --prefix zlib)/include" pyenv install 2.7.16 else run pyenv install 2.7.16
3. pyenv local 2.7.16 (This command shouldn't be required but if the dot file isn't picked up then this will set it)