Skip to content

Latest commit

 

History

History
70 lines (41 loc) · 2.64 KB

DEVELOPMENT.md

File metadata and controls

70 lines (41 loc) · 2.64 KB
Raw

Metapages

A metapage is a webpage that consists of a network of other embedded webpages.

For documentation and examples: https://metapages.org/

THIS IS OUT OF DATE, UNDER HEAVY DEVELOPMENT, CONTACT AUTHOR

Published artifacts

This repository publishes the following artifacts (and lists the source directory):

  1. javascript libraries:
    1. https://www.npmjs.com/package/metapage <- libs/metapage
    2. https://www.npmjs.com/package/metaframe <- libs/metaframe
  2. https://metapages.org/documentation/ <- docs documentation with running, interactive examples.

1) Javascript Libraries

Setup

Install required:

Install optional (advanced):

These tools are only required if you are compiling code on your host machine (if you want to do this, you'll know how to setup) rather than use the pre-configured docker-compose stack that requires no local host installs (except docker) and possibly just for the build commands.

  • haxe (or via homebrew: brew install haxe)
  • node.js (or via homebrew: brew install node)

Development loop

First

`just run`  OR `docker-compose up jekyll proxy shell-haxe test`: starts the jekyll dev server

Then:

  1. Edit haxe files, or documentation. Code and examples and documentation are all auto-compiled+reloaded. Source code in ./libs is in the Haxe language).
    1. haxe code is compiled, if successful, packaged into local libraries for the local web server. The library versions are latest.
      1. docs/js: for local development
      2. lib/build/npm: for building the npm+browser libraries
    2. The jekyll server reloads any changed docs files
  2. Comprehensive metapage test of the latest version: http://localhost:4000/tests/
  3. Repeat

Tips:

toggle the debug flag in libs/webpack.config.js toggle the jsondiff flag libs/build-base.hxml

If required, run the CI tests locally:

make ci-local-test-google-cloud-build

Deployment pipeline

  1. On master branch: just version-new-publish
  2. Google Cloud Build (./cloudbuild.yaml) sees the npm version is new, so creates and publishes new npm packages via make npm-publish

2) Documentation

The docs and examples are static webpages built by jekyll and server via github pages:

https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/