https://github.com/yagolopez/metaphasejs

:fire: Super easy, efficient and agnostic state management for Javascript
https://github.com/yagolopez/metaphasejs

agnostic client javascript management manager react reactjs redux state state-management state-manager typescript

Last synced: 11 days ago
JSON representation

:fire: Super easy, efficient and agnostic state management for Javascript

• Host: GitHub
• URL: https://github.com/yagolopez/metaphasejs
• Owner: YagoLopez
• License: mit
• Created: 2018-06-04T20:10:09.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-08-20T22:53:47.000Z (about 4 years ago)
• Last Synced: 2024-11-01T17:42:51.730Z (15 days ago)
• Topics: agnostic, client, javascript, management, manager, react, reactjs, redux, state, state-management, state-manager, typescript
• Language: HTML
• Size: 2.62 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/YagoLopez/metaphasejs.svg?branch=master)](https://travis-ci.org/YagoLopez/metaphasejs) [![Greenkeeper badge](https://badges.greenkeeper.io/YagoLopez/metaphasejs.svg)](https://greenkeeper.io/)

 [![Maintainability](https://api.codeclimate.com/v1/badges/c264e58f56102a22476c/maintainability)](https://codeclimate.com/github/YagoLopez/metaphasejs/maintainability)  [![Coverage Status](https://coveralls.io/repos/github/YagoLopez/metaphasejs/badge.svg?branch=master)](https://coveralls.io/github/YagoLopez/metaphasejs?branch=master) 

![NPM package](https://nodei.co/npm/metaphasejs.png)

[![Repository stats](https://github-readme-stats.vercel.app/api?username=YagoLopez&hide=["contribs"])](https://github.com/anuraghazra/github-readme-stats)

# MetaphaseJS

Super easy, efficient and agnostic state management for Javascript

# Demo

- [Link and code examples](https://github.com/YagoLopez/metaphasejs-react-demo)

# Usage

```javascript

// Install

yarn add metaphasejs // Yarn

npm install metaphasejs // NPM

// Build

yarn / npm build

// Test

yarn / npm test

```

## API Docs

- [Link](https://yagolopez.js.org/metaphasejs/docs/index.html)

## Packages Analysis

- Without gzip compression: [Link](https://yagolopez.js.org/metaphasejs/analysis.html)

## Test Coverage

- [Jest Report](https://yagolopez.js.org/metaphasejs/coverage/lcov-report/index.html)

- [Coveralls Report](https://coveralls.io/github/YagoLopez/metaphasejs)

## Contributing

1. Fork it

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## Caveats

- **IMPORTANT**: at this moment MetaphaseJS is not totally compatible with create-react-app (CRA) . The use of `constructor.name` breaks the compiled code by the CRA build script. The **uglifying process** has to be made with an *ad hoc* script called `build.js`. This script avoids to *mangle* funcion names using the option `mangle: {keep_fnames: true}`. Open an issue for more information. Pull requests are welcome.

- At this moment there are not **polyfills** for old browsers, but there will be in the future.

- If **Typescript** and **decorators** are used, its configuration file `tsconfig.json` must have:

  - `experimentalDecorators = true`

  - `emitDecoratorMetadata = true`

  - If flag `strict = true` is used, model properties (columns in db) must be initialized with values

## License

MIT

Back to top ↑