highmark-client v0.0.54

Highmark Client

Highmark's client.

Contents

• Introduction
• Installation
• Example
• Usage
• Building
• Acknowledgements
• Contact

Introduction

...

Installation

With npm:

npm install highmark-client

You can also clone the repository with Git...

git clone https://github.com/djalbat/highmark-client.git

...and then install the dependencies with npm from within the project's root directory:

npm install

You can also run a development server, see the section on building later on.

Example

There is a small development server that can be run from within the project's directory with the following command:

npm start

The example will then be available at the following URL:

http://localhost:8888

The source for the example can be found in the src/example.js file and corresponding src/example folder. You are encouraged to try the example whilst reading what follows. You can rebuild it on the fly with the following command:

npm run watch-debug

The development server will reload the page whenever you make changes.

One last thing to bear in mind is that this package is included by way of a relative rather than a package import. If you are importing it into your own application, however, you should use the standard package import.

Usage

...

Building

Automation is done with npm scripts, have a look at the package.json file. The pertinent commands are:

npm run build-debug
npm run watch-debug

Acknowledgements

• The Computer Modern CSS was adapted from Jonathan Häberle's computer-modern-web-font repository.

• The original Unicode Computer Modern fonts were created by Andrey V. Panov.

Contact

• james.smith@djalbat.com