driza v0.4.1

Still in development.

Driza

Raising the bar for cross-platform applications

Documentation • Discord Server

What is Driza?

Driza is a compiler and runtime that links web-based platforms (electron, browser, cordova) together. The goal is to remove that headache seemingly endless configuration.

This library does not just limit the platform options to electron, cordova, and the browser, anyone can build a platform implemention.

Current platform implementations

• Electron
• Android
• Static (www)
• Browser

Installation

npm install driza

API

• Cli
  • Default behavior
• Config
  • Build Options

Cli

Usage: sova [options] [arguments...]

Options:
  -v, --version  output the current version
  --config       Path to the config file.  By default driza will look for a `driza.config.js`
  --verbose      display lots of logs (good for debugging)
  --silent       only errors will show
  -h, --help     output usage information

If the config file exports a function at default, all arguments will be passed straight to that function.

Default Behavior

If a config is not found, driza will apply a default config.

By default that config will set watch.enable to true. This can be disabled with the nowatch argument.

By default that config will set the platform as electron. If the config finds a android or A argument, it will set the platform as android.

By default the config will set object to run. This can be changed to build by specifing a build argument, or compile by specifying a compile argument.

Config

The config file can be written in commonjs or es6.

It is required that the config file export default/module.exports an object containing the BuildOptions, or do the same to a function that returns the same type of object.

BuildOptions

Please refer to src/interfaces.ts#L39.

Development

Pull Requests are encouraged and always welcome. Pick an issue and help us out!

To install Driza locally:

git clone https://github.com/Vehmloewff/driza
cd driza
npm install

To build the compiler and runtime:

npm run build

To watch the file system and rebuild on changes:

npm run build -- -w

The compiler is located in the src/compiler directory.

Running the tests

The tests can be run with the following command:

npm test

To watch the file system and re-run the tests on changes:

npm test -- -w

License

MIT