@hubble/request

A simple, universal, no-frills networking library

View the docs

Installing

Install in your project with:

npm install @hubble/request

Or, with yarn:

yarn add @hubble/request

Development

Prerequisites

• docker
• docker-compose
• make

Setup

Run:

make dev-setup dev-build

Development

To rebuild the contents of dist every time you change a file in src, use:

make dev-run

Tests

You can run the tests, while running make dev-run, using:

make dev-test

You can re-run the tests every time you save a file using:

make dev-test-watch

Getting local node_modules

In order to have your code editor use node_modules to power its plugins (such as prettier and eslint), you'll need to export your node modules:

make dev-export-node-modules

Docs

We generate docs from JSDoc blocks on all our React code.

To view the docs locally, run

make dev-docs

This will generate the docs. You can view them at http://localhost:9004

Publishing

Once your branch has been approved and merged, follow these steps from main to publish:

1. Ensure your local main is up to date: git pull
2. In one terminal tab, start the dev container: make dev-run
3. In a new tab, open a shell in the running container: make dev-ssh
4. Bump the version — this will update package.json and automatically create a commit and tag: yarn version
5. If the remote has received commits since the container was built, rebase on top of them: git pull --rebase
6. Push the commit and tag to the repository: git push && git push --tags
7. Build the distributable: yarn build
8. Log in to npm using an account authorised to publish to the @hubble namespace: yarn login
9. Publish to npm: yarn publish