mframejs
Version:
simple framework
46 lines (29 loc) • 2.11 kB
Markdown
# MFrameJs
[](https://travis-ci.org/mframejs/mframejs)
[](https://opensource.org/licenses/mit-license.php)
[](https://github.com/ellerbrock/typescript-badges/)
[](https://codecov.io/gh/mframejs/mframejs)
Hobby project Im working on to learn more html/js/ts/css.
## How to install:
```npm install mframejs```
## How to use (in progress):
* https://mframejs.gitbook.io/docs/
* https://github.com/mframejs-codesandbox-samples
## Scripts for developement
* `npm run watch` to build project and run dev server.
* `npm run test` runs `test:typescript:tslint && test:jest:coverage && codecov` (used travisCI only)
* `npm run test:commit` runs `test:typescript:tslint && test:jest:coverage` use before commit/PR.
* `npm run test:watch` run jest tests under test folder with jest watch.
* `npm run test:typescript:tslint` to lint and test all code under src and test folder.
* `npm run test:jest` run jest tests under test folder.
* `npm run test:jest:coverage` same as above but also generates code coverage under `/coverageUnit`.
* `npm run build` build new dist & distTS folder.
## Developement notes
* When using `npm run watch` it makes a copy of `src/sample-base`.
* I do not want a huge sample in main repository.
* Sample folder is also using index.ts and main entry, so it can easly be added to stackblitzcom or other way around
## Project Status
* This is a hobby project to learn and see what Im able to do.
* There can come a lot of breaking changes until I release v1.0.0
* Not following semver much until I get to v1.0.0, so if you happend to use it in a app then you should lock it to a version, try and bump minor on breaking changes until v1
* Its very stable, but there are a few parts Ive been experimenting with and needs to be better