@hastearcade/web
TypeScript icon, indicating that this package has built-in type declarations

4.1.1 • Public • Published

@hastearcade/web

npm version

Overview

The @hastearcade/web SDK empowers developers to incoroporate the Haste authentication system into their web based game. The SDK is intended to be used only on the client side, but it is required to be used in conjunction with @hastearcade/server. See details here.

See here for an overview of the haste-sdk repository.

The Haste team prefers to install libraries via npm install like npm install @hastearcade/web.

However, if you prefer to utilize a single script tag you can include the following tag in your HTML:

<script src="https://unpkg.com/@hastearcade/web/dist/umd/index.js" />

SPECIAL NOTE

If you utilize the script tag above you must preface all your code with haste. For example instead of

const hasteClient = await HasteClient.build(process.env.HASTE_GAME_CLIENT_ID);

you would need to use

const hasteClient = await haste.HasteClient.build(process.env.HASTE_GAME_CLIENT_ID);

Table of Contents

Background

See here for a detailed background.

Setup

See here for a detailed setup guide.

Testing

@hastearcade/web utilizes Jest for running tests. To run all tests in the server package use the following command

npm run test

Documentation

This README and each package's README provides high-level documentation. Additionally the code has been reviewed and comments provided to aid future developers in understanding why certain decisions were made.

More comprehensive documentation can be found here.

License

The haste-sdk repository along with the corresponding npm packages are currently licensed under MIT

Contributing

If you are a developer looking to contribute to the Haste ecosystem please review our Contributing Readme and our Contributing Guidelines

Authors

Package Sidebar

Install

npm i @hastearcade/web

Weekly Downloads

23

Version

4.1.1

License

MIT

Unpacked Size

32.8 kB

Total Files

27

Last publish

Collaborators

  • ejnwmn
  • bowsr
  • ian-haste
  • rallieon
  • foundrium