mirror of
https://github.com/fluencelabs/aqua.git
synced 2024-12-04 14:40:17 +00:00
aa10706506
* move integration tests to repo * Move aqua-playground CI * Fix * Use local aqua cli * Move aqua tests to e2e * Test new build.sbt * Fix? * Test * Test * Test * Test * Update * Fix * Fix * Fix * fix * Fix * Rename aqua-api to api directory for consistency * Migrate to pnpm * Add bump version script * Test snapshot workflow * fix * Fix * Fix * Setup pnpm * Update pnpm version * Fix * Do not publish tests * Update * Fix * Fix? * delete import * Fix * Fix * Fix? * Fix * Fix * Use main branch * Fix quotes * Fix * Fix release * Cleanup * Remove compiled examples * Cleanup --------- Co-authored-by: DieMyst <dmitry.shakhtarin@fluence.ai>
65 lines
3.7 KiB
Markdown
65 lines
3.7 KiB
Markdown
# Aqua
|
|
|
|
[](https://github.com/fluencelabs/aqua/actions/workflows/release.yml)
|
|
[](https://www.npmjs.com/package/@fluencelabs/aqua)
|
|
|
|
[Aqua](https://fluence.dev/docs/aqua-book/introduction) is an open-source language for distributed workflow coordination in p2p networks. Aqua programs are executed on many peers, sequentially or in parallel, forming a single-use coordination network. Applications are turned into hostless workflows over distributed function calls, which enables various levels of decentralization: from handling by a limited set of servers to complete peer-to-peer architecture by connecting user devices directly. Aqua is the core of the [Fluence](https://fluence.network/) protocol and a framework for internet or private cloud applications.
|
|
|
|
|
|
## Installation and Usage
|
|
|
|
The easiest way to use Aqua is to download the latest build from npm: [@fluencelabs/aqua](https://www.npmjs.com/package/@fluencelabs/aqua).
|
|
|
|
```bash
|
|
npm i -g @fluencelabs/aqua
|
|
aqua --input src/aqua --output src/generated
|
|
```
|
|
|
|
Input directory should contain files with `.aqua` scripts.
|
|
|
|
Other ways of installing Aqua can be found in [INSTALL.md](./INSTALL.md).
|
|
|
|
|
|
## Documentation
|
|
|
|
Comprehensive documentation and usage examples as well as a number of videos can be found in [Aqua Book](https://fluence.dev/docs/aqua-book/introduction). [Aqua Playground](https://github.com/fluencelabs/aqua-playground) demonstrates how to start writing Aqua and integrate it into a [TypeScript](https://www.typescriptlang.org/) application. Numerous videos are available at our [YouTube channel](https://www.youtube.com/@fluencelabs).
|
|
|
|
|
|
## Repository Structure
|
|
|
|
- [**api**](./api) - Aqua API for JS
|
|
- [api](./api/api) - Scala sources
|
|
- [api-npm](./api/api-npm) - JS project
|
|
- [api-example](./api/api-example) - usage example
|
|
- [**aqua-run**](./aqua-run) - Aqua API to run functions
|
|
- [**backend**](./backend) - compilation backend interface
|
|
- [backend/air](./backend/air) - generates AIR code from the middle-end model
|
|
- [backend/ts](./backend/ts) - generates AIR code and TypeScript wrappers for use with [Fluence JS]( https://github.com/fluencelabs/fluence-js) SDK
|
|
- [**cli**](./cli) - CLI interface
|
|
- [cli](./cli/cli) - Scala sources
|
|
- [cli-npm](./cli/cli-npm) - JS project
|
|
- [**compiler**](./compiler) - compiler as a pure function made from _linker_, _semantics_ and _backend_
|
|
- [**model**](./model) - middle-end, internal representation of the code, optimizations and transformations
|
|
- [transform](./model/transform) - optimizations and transformations, converting model to the result, ready to be rendered
|
|
- [test-kit](./model/test-kit) - tests and test helpers for the model and transformations
|
|
- [**linker**](./linker) - checks dependencies between modules, builds and combines an abstract dependencies tree
|
|
- [**parser**](./parser) - parser, takes source text and produces a source AST
|
|
- [**semantics**](./semantics) - rules to convert source AST into the model
|
|
- [**types**](./types) - data types, arrows, stream types definitions and variance
|
|
|
|
|
|
## Support
|
|
|
|
Please, file an [issue](https://github.com/fluencelabs/aqua/issues) if you find a bug. You can also contact us at [Discord](https://discord.com/invite/5qSnPZKh7u) or [Telegram](https://t.me/fluence_project). We will do our best to resolve the issue ASAP.
|
|
|
|
|
|
## Contributing
|
|
|
|
Any interested person is welcome to contribute to the project. Please, make sure you read and follow some basic [rules](./CONTRIBUTING.md).
|
|
|
|
|
|
## License
|
|
|
|
All software code is copyright (c) Fluence Labs, Inc. under the [Apache-2.0](./LICENSE) license.
|
|
|