Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vuquangpham/boilw
Creating Javascript library on the fly 💫
https://github.com/vuquangpham/boilw
boil-collections boilerplate javascript webpack
Last synced: about 1 month ago
JSON representation
Creating Javascript library on the fly 💫
- Host: GitHub
- URL: https://github.com/vuquangpham/boilw
- Owner: vuquangpham
- License: mit
- Created: 2022-10-24T03:10:02.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-02T11:42:42.000Z (9 months ago)
- Last Synced: 2024-10-15T08:49:02.181Z (3 months ago)
- Topics: boil-collections, boilerplate, javascript, webpack
- Language: JavaScript
- Homepage:
- Size: 139 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Boilw Template
> Creating Javascript library on the fly 💫
## Getting started
### Options
| Name | Default | Description |
| -------------------- | ---------- | ------------------------------- |
| `id` | `unique` | id for clarifying each instance |
| --- | -- | -- |
| `events(self) => {}` | `function` | |
### Methods of Grab
| Name | Parameter | Description |
| --------- | ---------- | -------------------- |
| `create` | `object` | create the instance |
| `get` | `id` | get the instance |
| `destroy` | `instance` | destroy the instance |
### Methods of instance
| Name | Parameters | |
| --------- | ------------------ | ---------------- |
| `on` | `(name, callback)` | trigger events |
| `destroy` | `()` | destroy instance |
## Deployment
Run `./dev` in live server
```shell
npm run dev
```
Build files from `./src` to `./dist` for production
```shell
npm run prod
```
Build files from `./src` and `./dev` to `./dist` for production
```shell
npm run build
```