aqua/npm/readme.md
Pavel 3f7ef9f264
Create aquamarine npm package (#56)
* Create aquamarine npm package
2021-04-14 18:00:51 +03:00

59 lines
1.2 KiB
Markdown

## Aqua
Aqua is a new-gen language for distributed systems.
Aqua programs are executed on many peers, sequentially
or in parallel, forming a single-use coordination network.
Aqua's runtime is heterogeneous: it includes browsers, servers, devices, all involved in solving a single task.
Therefore, Aqua scripts are compiled into several targets at once, with AIR and Typescript as a default.
## aqua-cli
The package contains a convenience `aqua-cli` wrapper for usage in npm-based projects.
### usage
**Warning: the package requires java to be installed (it will call "java -jar ... ") **
Get the latest package
```bash
npm i --save-dev @fluencelabs/aqua-cli
```
Create a directory for the source files: `.aqua` and for compiled files: `.ts`
```
mkdir aqua compiled
```
To compile files run:
```bash
npx aqua -i ./src/aqua/ -o ./src/compiled
```
Alternatively the compilation script can be put into scripts section of `package.json`
```
...
"scripts": {
...
"compile": "aqua -i ./src/aqua/ -o ./src/compiled"
},
...
```
and can be started with
```
npm run compile
```
### references
- For the list of compiler options see: https://github.com/fluencelabs/aqua
- To get started writing aqua see: https://github.com/fluencelabs/aqua-playground