Skip to content
Snippets Groups Projects
Commit e91d0be7 authored by aeschylus's avatar aeschylus Committed by GitHub
Browse files

first pass at readme

parent bbf318d8
Branches
No related tags found
No related merge requests found
** Running the module
This module is intended to be a console-only version of the a Mirador-like viewer, with tests and the ability to manipulate the state tree through actions in the console.
To run the module, first make sure you are in this directory (`minimal_redux_poc`), then:
1. Run the `npm run build:umd` task. This will produce an "isomorphic" webpack bundle of the module that can run in the console or browser. The bundle will be called `index.umd.js` and is placed in this same directory.
2. Open a nodejs console (type `node`) in this directory.
3. Require the module under a variable name, for example, `state = require('./index.umd')`.
4. The exported module currently has most of its functionality under the "store" property, so you may prefer to include it with `state = require('./index.umd').store`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment