fluencelabs/aqua-playground
1
0
Fork 0
mirror of https://github.com/fluencelabs/aqua-playground synced 2025-03-15 19:51:13 +00:00
Code Issues Projects Releases Wiki Activity

Removed readme

Browse Source
This commit is contained in:
InversionSpaces 2023-05-16 19:28:13 +02:00
parent e3cc2bc230
commit 2f48e5eff7
1 changed files with 0 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -1,48 +0,0 @@
# Aqua playground
Repository demonstrating the how to start writing aqua and integrate it into a typescript application
## Getting started
**Warning: java is required to be installed in order to use aqua compiler**
Install dependencies
```
npm install
```
To compile the aqua files execute
```
npm run compile-aqua
```
To start the `index.ts` execute
```
npm run run
```
To run all examples in `example` directory
```
npm run exec
```
If everything works correctly logs without errors will be printed on a screen:
Then you can add or modify `aqua` files in `aqua` directory, these files will be compiled into `/src/compiled` and you can use it in a TypeScript in your preferable way.
## Project structure
Aqua source files are located in `src/aqua`directory.
Aqua files are compiled into .ts located in `/src/compiled` directory.
Entry point to use aqua compiled files from TypeScript: `/src/index.ts`
Code that call all examples and check results: `/src/run-examples.ts`
## References
\- Documentation for the compiler can be found in the official repo: https://github.com/fluencelabs/aqua