Table of Contents

• Installation
• Development
• Environment
• Testing
• Commands
• Code style
• Contributors
• See Also

Installation

First, make sure you have the latest version of node.js

To use this project you also need lerna. Lerna is a tool for managing JavaScript projects with multiple packages. .

npm i lerna -g

Then you should install dependencies using the bootstrap command.

lerna bootstrap

Development

Beta app

To start beta app with bankai.

npm start

By default, the app is accessible at https://localhost:8080.

See bankai docs for usage.

Other apps (embed, upload, ...)

Replace embed with the target app if different.

lerna run --scope embed start --parallel

Add a package

lerna add @resonate/button --scope "beta"

Add a dev dependency

Here's how you would add gulp to tools

lerna add gulp --scope tools

Build

Compile app to dist using bankai.

npm run build

To compile a specific package

lerna run build --scope "@resonate/rangeslider"

Testing

Run all tests (standard, dependency-check)

npm test

Test a specific component

lerna run test --scope "@resonate/player-component"

A package can have browser tests (tape-run)

lerna run test:browser --scope "@resonate/api-factory-generator"

Environment

Setup your env variables for development

cp .env.example .env

Nginx

You can find an example nginx configuration file in the docs.

HTTPS

Secure connection is required to fully test PWA's. Bankai does generate a certificate for localhost. It should be located at ~/.config/bankai. See HTTPS instructions.

If you want, you can generate a custom certificate using mkcert for beta.resonate.localhost. This origin is whitelisted in our CORS config.

Commands

Commands needs to be ran with $ lerna run.

Example: $ lerna run --scope beta start --parallel.

Code style

We use standard as a linter and javascript style guide. Make sure to add appropriate plugin for your editor (see: standard#are-there-text-editor-plugins)

Maintainers

• Augustin Godiscal [email protected]
• Marie [email protected]

See Also

• choo - sturdy 4kb frontend framework
• bankai - streaming asset compiler
• nanohtml - HTML template strings for the Browser with support for Server Side Rendering in Node. strings
• nanocomponent - create performant HTML components
• tachyons - functional CSS for humans
• sheetify - modular CSS bundler for browserify