@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

To publish:

1. In one terminal tab, run make dev-run
2. Open a new tab. Run make dev-ssh
3. Bump the version, using yarn version
4. Push the update, and the tag, to the git repository: git push && git push --tags
5. Log in to npm, using an account authorized to push to the @hubble namespace: yarn login
6. Publish to npm: yarn publish