https://github.com/nichoth/template-ts-browser

Template for typescript projects in a browser environment
https://github.com/nichoth/template-ts-browser

Last synced: over 1 year ago
JSON representation

Template for typescript projects in a browser environment

• Host: GitHub
• URL: https://github.com/nichoth/template-ts-browser
• Owner: nichoth
• License: mit
• Created: 2023-03-17T02:42:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-28T04:49:04.000Z (over 1 year ago)
• Last Synced: 2024-12-19T01:32:49.496Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 149 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.example.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# package name here

![tests](https://github.com/bicycle-codes/crypto-util/actions/workflows/nodejs.yml/badge.svg)

[![types](https://img.shields.io/npm/types/@substrate-system/icons?style=flat-square)](README.md)

[![module](https://img.shields.io/badge/module-ESM%2FCJS-blue?style=flat-square)](README.md)

[![semantic versioning](https://img.shields.io/badge/semver-2.0.0-blue?logo=semver&style=flat-square)](https://semver.org/)

[![Common Changelog](https://nichoth.github.io/badge/common-changelog.svg)](./CHANGELOG.md)

[![install size](https://flat.badgen.net/packagephobia/install/@nichoth/session-cookie)](https://packagephobia.com/result?p=@nichoth/session-cookie)

[![dependencies](https://img.shields.io/badge/dependencies-zero-brightgreen.svg?style=flat-square)](package.json)

[![license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

``

[See a live demo](https://namespace.github.io/package-name/)

Contents


## install

Installation instructions

```sh

npm i -S @namespace/package

```

## API

This exposes ESM and common JS via [package.json `exports` field](https://nodejs.org/api/packages.html#exports).

### ESM

```js

import '@namespace/package/module'

```

### Common JS

```js

require('@namespace/package/module')

```

## CSS

### Import CSS

```js

import '@namespace/package-name/css'

```

Or minified:

```js

import '@namespace/package-name/css/min'

```

### Customize CSS via some variables

```css

component-name {

    --example: pink;

}

```

## use

`usage instructions here`

### JS

```js

import '@namespace/package/module'

```

### pre-built JS

This package exposes minified JS files too. Copy them to a location that is

accessible to your web server, then link to them in HTML.

#### copy

```sh

cp ./node_modules/@namespace/package/dist/module.min.js ./public

```

#### HTML

```html

```