If you want to build on the API for personal use, take a look through the work done in the Migrate to new APIs project and consider checking the backlog in our community forum.
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
To start beta app with bankai
.
npm start
By default, the app is accessible at https://localhost:8080
.
You can run the app at a different port using the command below:
npm run dev -- -- --port 8089
See bankai docs for usage.
Replace embed
with the target app if different.
lerna run --scope embed start --parallel
lerna add @resonate/button --scope "beta"
Here's how you would add gulp to tools
lerna add gulp --scope tools
Compile app to dist
using bankai.
npm run build
To compile a specific package
lerna run build --scope "@resonate/rangeslider"
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"
Setup your env variables for development
cp .env.example .env
You can find an example nginx configuration file in the docs.
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 needs to be ran with $ lerna run
.
Example: $ lerna run --scope beta start --parallel
.
Command | Description |
---|---|
$ npm run dev |
Start beta app development server |
$ npm test |
Lint, validate deps & run dependency-check for all packages |
$ npm run build |
Compile all beta app files into beta/dist/ |
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)
- Augustin Godiscal [email protected]
- Marie [email protected]
- 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