react-webhsd v0.1.0-tmp2

WebHSD

WebHSD is a reusable web-component letting consumer browser application to communicate with boards powered by FP-SNS-DATALOG and connected to local PC via USB.

# With NPM
npm install webhsd
# With Yarn
yarn add webhsd

import webhsd from 'webhsd';

const MyApp = () => {
  return (
    <div>
      <webhsd />
    </div>
  )
}

Important notes

1. WebHSD component leverages Web USB API provided by the browser. Check documentation for browser compatibility.
2. WebHSD component leverages web workers to implement critical features from performance point of view (e.g. filesystem, USB devices. etc.). In order to enable online download of web-workers files from consumer web app, copy ./build/static/js content into public folder for static content.

🔎 What's inside?

A quick look at the top-level files and directories included with this template.

.
├── .storybook
├── node_modules
├── build
├── src
├── .env
├── .gitignore
├── LICENSE
├── package.json
├── yarn.lock
└── README.md

1. .storybook: This directory contains Storybook's configuration files.

2. node_modules: This directory contains all of the modules of code that your project depends on (npm packages).

3. public: This directory will contain the development and production build of the site.

4. build: This directory will contain the production sample application using web components offered by the library

5. src: This directory will contain all of the code related to what you will see on your application.

6. .env: Simple text configuration file for controlling the application's environment constants.

7. .gitignore: This file tells git which files it should not track or maintain during the development process of your project.

8. LICENSE: The template is licensed under the MIT licence.

9. package.json: Standard manifest file for Node.js projects, which typically includes project specific metadata (such as the project's name, the author among other information). It's based on this file that npm will know which packages are necessary to the project.

10. yarn.lock: This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (Do not change it manually).

11. README.md: A text file containing useful reference information about the project.