diff --git a/.gitbook/assets/image (12).png b/.gitbook/assets/image (12).png new file mode 100644 index 0000000..971b427 Binary files /dev/null and b/.gitbook/assets/image (12).png differ diff --git a/.gitbook/assets/image (13).png b/.gitbook/assets/image (13).png new file mode 100644 index 0000000..a45fc2b Binary files /dev/null and b/.gitbook/assets/image (13).png differ diff --git a/.gitbook/assets/image (14).png b/.gitbook/assets/image (14).png new file mode 100644 index 0000000..b4c373c Binary files /dev/null and b/.gitbook/assets/image (14).png differ diff --git a/.gitbook/assets/image (15).png b/.gitbook/assets/image (15).png new file mode 100644 index 0000000..2ac620a Binary files /dev/null and b/.gitbook/assets/image (15).png differ diff --git a/.gitbook/assets/image (16).png b/.gitbook/assets/image (16).png new file mode 100644 index 0000000..7bb6c6b Binary files /dev/null and b/.gitbook/assets/image (16).png differ diff --git a/.gitbook/assets/image (17).png b/.gitbook/assets/image (17).png new file mode 100644 index 0000000..9d7fe1f Binary files /dev/null and b/.gitbook/assets/image (17).png differ diff --git a/.gitbook/assets/image (18).png b/.gitbook/assets/image (18).png new file mode 100644 index 0000000..971b427 Binary files /dev/null and b/.gitbook/assets/image (18).png differ diff --git a/.gitbook/assets/image (19).png b/.gitbook/assets/image (19).png new file mode 100644 index 0000000..9d7fe1f Binary files /dev/null and b/.gitbook/assets/image (19).png differ diff --git a/.gitbook/assets/image (20).png b/.gitbook/assets/image (20).png new file mode 100644 index 0000000..eef0bca Binary files /dev/null and b/.gitbook/assets/image (20).png differ diff --git a/quick-start.md b/quick-start.md index 029180a..ba1cf58 100644 --- a/quick-start.md +++ b/quick-start.md @@ -1,8 +1,57 @@ # Quick Start -Fluence provides a [docker-based development environment](https://github.com/fluencelabs/devcontainer) that comes with the necessary dependencies and tooling pre-installed. Moreover, the `devcontainer` includes a three part tutorial covering Aqua, Marine and Tooling. +Fluence provides a [docker-based development environment](https://github.com/fluencelabs/devcontainer) that comes with the necessary dependencies and tooling pre-installed. Moreover, the `devcontainer` includes a three part tutorial covering Aqua, Marine, and Tooling. -Please follow the [Readme](https://github.com/fluencelabs/devcontainer/blob/main/README.md) for installation and tutorial instructions. +### Fluence Devcontainer + +Fluence's devcontainer is a ready to use dockerized development environment with VSCode integration containing the following tools: + +* [`aqua-cli`](https://www.npmjs.com/package/@fluencelabs/aqua-cli) to compile [Aqua](https://doc.fluence.dev/aqua-book/) to AIR or Typescript +* [`fldist`](https://www.npmjs.com/package/@fluencelabs/fldist) to manage services and optionally execute compiled Aqua from the command line +* [`marine`](https://crates.io/crates/marine) to compile services developed in Rust to the wasm32-wasi target +* [`mrepl`](https://crates.io/crates/mrepl) to run, test and debug Wasm services locally + +### How to install + +Docker and optionally VSCode need to be available on your system. For Docker installation, follow the [Get Docker](https://docs.docker.com/get-docker/) instructions for your OS. For VSCode, see [VSCocde](https://code.visualstudio.com/) for instructions. + +With Docker and VSCode in place: + +* Install Remote-Containers extension in VSCode + +![Install Remote - Containers in VSCode](.gitbook/assets/image%20%2813%29.png) + +* Run Remote-Containers: Clone Repository in Container Volume... through command palette \(F1 or Cmd-Shift-P\) + +![Select Remote Container Clone Repository](.gitbook/assets/image%20%2814%29.png) + +* Enter `fluencelabs/devcontainer` + +![Select \`fluencelabs/devcontainer\`](.gitbook/assets/image%20%2815%29.png) + +* When asked for branch, press enter \(main\) +* When asked for volume, press enter \(unique\) +* open Terminal within VSCode \(ctrl-\`\) + +![Installed And Ready Devcontainer in VSCodes](.gitbook/assets/image%20%2812%29.png) + +Congratulations, you now have a fully functional Fluence development environment. For a variety of container management options, click on the `Dev Container: Fluence` button in the lower left of your tools bar: + +![Container Management Option Menu](.gitbook/assets/image%20%2816%29.png) + +### Quickstart Tutorial + +The container includes the Quick Start tutorial in the `tutorial` directory with introductions to + +1. Developing decentralized applications with `Aqua` +2. Developing custom service modules with `Marine` +3. Managing custom service lifecycle with `fldist` + +We recommend you follow the above outlined sequence of tutorial sections starting with `Aqua` . + +![Start With The Aqua Tutorial in VSCode](.gitbook/assets/image%20%2820%29.png) +If you encounter any problems or have suggestions, please open an issue or submit a PR. You can also reach out in [Discord](https://fluence.chat) or [Telegram](https://t.me/fluence_project). For more detailed reference resources, see the [Fluence documentation](https://doc.fluence.dev/docs/) and [Aqua book](https://doc.fluence.dev/aqua-book/). +