YAML theme repo for use with zenbu.
You may (and probably should) substitute npm
with yarn
.
- To install dependencies:
npm install && bower install
- To start serving for production:
npm start
(be sure to build first!) - To run the dev servers:
npm run dev
- The main server is at
localhost:3000
, which proxies everything but/api
towebpack-dev-server
atlocalhost:8080
- The main server is at
- To test:
npm test
,npm run test:watch
, ornpm run test:browser
- To build deduplicated, minified html/scripts into
dist/
:npm run build
The webpack configuration is generated based on npm_lifecycle_event
, so
running the scripts from package.json
directly will not yield the correct
results.
All files are in app/
unless otherwise noted.
- All React components are pure functional components with Redux.
- The entry point is
main.coffee
, which also sets up hot reloading. - The root component used for routing, etc. can be found at
Root.coffee
. - Each subcomponent gets a folder in
components/
with the following structure:index.coffee
: Exports a Redux-connected component.style.l.styl
: Locally scoped styles for the component.
- The store can be found at
store.coffee
, and the root reducer atreducers/index.coffee
. - Each reducer gets a file in
reducers/
, and is automatically imported. It manages the state sub-tree matching its filename, sans extension. - Actions are created and handled using redux-act.
- Actions can be found at
actions/index.coffee
. - Async actions can be found at
actions/async.coffee.
- Actions can be found at
- Tests are considered any file within the
app
tree ending with.spec.*
, where*
is any extension (e.g.coffee
). These are all automatically picked up bynpm test
.
Probably will be GraphQL, TBD.