https://github.com/mazeyqian/mazey-npm-template

Mazey's npm template.
https://github.com/mazeyqian/mazey-npm-template

npm template

Last synced: 16 days ago
JSON representation

Mazey's npm template.

• Host: GitHub
• URL: https://github.com/mazeyqian/mazey-npm-template
• Owner: mazeyqian
• License: mit
• Created: 2017-11-08T14:09:07.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-05T06:18:12.000Z (about 1 month ago)
• Last Synced: 2024-10-19T02:08:46.103Z (21 days ago)
• Topics: npm, template
• Language: JavaScript
• Homepage:
• Size: 54.7 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
⚠️ Note: The project is a template for npm. Please don't use it directly.

# mazey-npm-template

[![npm version][npm-image]][npm-url]

[![l][l-image]][l-url]

[npm-image]: https://img.shields.io/npm/v/mazey-npm-template

[npm-url]: https://npmjs.org/package/mazey-npm-template

[l-image]: https://img.shields.io/npm/l/mazey-npm-template

[l-url]: https://github.com/mazeyqian/mazey-npm-template

Mazey's npm template description.

## Install

Use mazey-npm-template via [npm](https://www.npmjs.com/package/mazey-npm-template).

```shell

npm install mazey-npm-template --save

```

Of course, you can also download this file and serve it yourself. The file locates at the `lib/mazey-npm-template.min.js`.

## Usage

Foo foo foo example.

```javascript

import { foo } from 'mazey-npm-template';

foo(); // true

```

Bar bar bar example.

```javascript

import { bar } from 'mazey-npm-template';

bar(); // false

```

## Contributing

### Development Environment

#### Node.js

- v16.19.0

#### TypeScript

- v5.1.6

### Scripts

Install Dependencies:

```shell

npm i

```

Development:

```shell

npm run dev

```

Build:

```shell

npm run build

```

Document:

```shell

npm run docs

```

Test:

```shell

npm run test

```

## License

This software is released under the terms of the [MIT license](https://github.com/mazeyqian/mazey-npm-template/blob/main/LICENSE).