README.md

--TODO--

--TODO-- ... // TODO

// TODO

---

Library Tests (Demo)

---

Overview

The main purpose of --TODO-- is...

Deployment / Import

npm install @byojs/--TODO--

The @byojs/--TODO-- npm package includes a dist/ directory with all files you need to deploy --TODO-- (and its dependencies) into your application/project.

Note: If you obtain this library via git instead of npm, you'll need to build dist/ manually before deployment.

Using a bundler

If you are using a bundler (Astro, Vite, Webpack, etc) for your web application, you should not need to manually copy any files from dist/.

Just import like so:

import { /* TODO */ } from "@byojs/--TODO--";

The bundler tool should pick up and find whatever files (and dependencies) are needed.

Without using a bundler

If you are not using a bundler (Astro, Vite, Webpack, etc) for your web application, and just deploying the contents of dist/ as-is without changes (e.g., to /path/to/js-assets/--TODO--/), you'll need an Import Map in your app's HTML:

<script type="importmap">
{
    "imports": {
        "--TODO--": "/path/to/js-assets/--TODO--.mjs"
    }
}
</script>

Now, you'll be able to import the library in your app in a friendly/readable way:

import { /* TODO */ } from "--TODO--";

Note: If you omit the above --TODO-- import-map entry, you can still import --TODO-- by specifying the proper full path to the --TODO--.mjs file.

--TODO-- API

The API provided by --TODO--...

// .. TODO

// TODO

Re-building dist/*

If you need to rebuild the dist/* files for any reason, run:

# only needed one time
npm install

npm run build:all

Tests

This library only works in a browser, so its test suite must also be run in a browser.

Visit https://byojs.dev/--TODO--/ and click the "run tests" button.

Run Locally

To instead run the tests locally, first make sure you've already run the build, then:

npm test

This will start a static file webserver (no server logic), serving the interactive test page from http://localhost:8080/; visit this page in your browser and click the "run tests" button.

By default, the test/test.js file imports the code from the src/* directly. However, to test against the dist/* files (as included in the npm package), you can modify test/test.js, updating the /src in its import statements to /dist (see the import-map in test/index.html for more details).

License

All code and documentation are (c) 2024 --TODO-- and released under the MIT License. A copy of the MIT License is also included.