https://github.com/logofx/aurelia2-mvvm-plugin
https://github.com/logofx/aurelia2-mvvm-plugin
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/logofx/aurelia2-mvvm-plugin
- Owner: LogoFX
- Created: 2025-07-03T23:11:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-05T20:25:45.000Z (12 months ago)
- Last Synced: 2025-07-05T20:31:21.243Z (12 months ago)
- Language: JavaScript
- Size: 323 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# aurelia2-mvvm-plugin
This project is bootstrapped by [aurelia/new](https://github.com/aurelia/new).
## Start dev web server
npm start
Note this plugin project comes with a dev-app. The above command starts the dev app in `dev-app/` folder. The plugin source code is in `src/` folder.
## Build the plugin in production modern
npm run build
It builds plugin into `dist/index.js` file.
Note when you do `npm publish` or `npm pack` to prepare the plugin package, it automatically run the above build command by the `prepare` script defined in your package.json `"scripts"` section.
## Consume the plugin
If your plugin is published to npm or a private registry, just install the plugin package.json
npm install aurelia2-mvvm-plugin
If you want to directly use plugin's git repo.
npm install git@github.com:username/aurelia2-mvvm-plugin.git
or
npm install https://some.git.server/username/aurelia2-mvvm-plugin.git
If you want to install from local folder, don't do "npm install ../local/aurelia2-mvvm-plugin/" as the folder's `node_modules/` will cause webpack to complain about duplicated dependency like "@aurelia/metadata".
In this plugin's folder, do
npm pack
This will pack the plugin into aurelia2-mvvm-plugin
In an application project's main file.
```js
import * as myPlugin from 'aurelia2-mvvm-plugin';
Aurelia
// Load all exports from the plugin
.register(myPlugin)
.app(MyApp)
.start();
```
## Unit Tests
npm run test
Run unit tests in watch mode.
npm run test:watch
## Analyze webpack bundle
npm run analyze