mirror of
https://github.com/fluencelabs/gitbook-docs
synced 2025-04-25 16:02:17 +00:00
55 lines
2.9 KiB
Markdown
55 lines
2.9 KiB
Markdown
# 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 Devcontainer
|
|
|
|
Fluence's devcontainer is a ready to use dockerized development environment with VSCode integration containing the following tools:
|
|
|
|
- [`aqua`](https://www.npmjs.com/package/@fluencelabs/aqua) 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
|
|
|
|
|
|
|
|
- Run Remote-Containers: Clone Repository in Container Volume... through command palette \(F1 or Cmd-Shift-P\)
|
|
|
|
|
|
|
|
- Enter `fluencelabs/devcontainer`
|
|
|
|
|
|
|
|
- When asked for branch, press enter \(main\)
|
|
- When asked for volume, press enter \(unique\)
|
|
- open Terminal within VSCode \(ctrl-\`\)
|
|
|
|
|
|
|
|
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 tool bar:
|
|
|
|
|
|
|
|
### 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` .
|
|
|
|
|
|
|
|
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/).
|