0.0.1 • Published 7 years ago

muons v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
7 years ago

Framwork X

Minimal plugin based React/Redux framework built on top of neutrino.

Why?

Stop rebuilding the same functionality in all your react apps. Use whatever tooling you like. Take advantage of some convention over configuration.

Why Muon? Muon's are a category of neutrino particles.

researchers reported that muon neutrinos were apparently traveling at faster than light speed.

Muon will help you speed up the development of your React applications.

What it is not...

  • kitchen sink tool
  • server side rendered enabled
  • opinionated on which tools you use (Jest vs. Mocha, etc.)
  • the right solution for everyone
  • providing a solution for building your API/backend

What is is...

  • a way to build react apps quicker
  • a way to reuse react modules in multiple apps
  • a way to build the perfect 'React Stack' for your team but still leverage community contributions.
  • a way to stop bikeshedding about ideal project structure

Plugins

import framework from 'framework';
import myPlugin from 'my-plugin';
import Root from './Root';

const app = framework();

app.use(myPlugin(/* options */));

app.mount(Root);

Building Plugins

module.exports = {
  reducer: () => {},
  actions: {
    toast: msg => { type: 'ADD_TOAST', msg }
  },
  build: [
    "array-of-neutrino-presets",
  ],
  
  // Prob won't include in V1
  blueprints: [
    "path_to_blueprints",
  ],
};

Framework Conventions

  1. Source code has to live in src
  2. Test code has to live in test
  3. Root component must be exported from src/index.js