Skip to content

Commit cb53346

Browse files
committed
add Cookbook
1 parent fb209e4 commit cb53346

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+9116
-89
lines changed

bun.lockb

-18.3 KB
Binary file not shown.

docs/index.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,22 @@ Let's discover **Fluent CI in less than 5 minutes**.
99

1010
## What is Fluent CI?
1111

12-
Fluent CI is a CI/CD tool that allows you to build, test, and deploy your code. It is a self-hosted solution built on top of [Dagger](https://dagger.io/), [Wasm](https://webassembly.org) and [Deno](https://deno.land/), can be run locally or on a server, and is completely free and open-source.
12+
Fluent CI is a CI/CD tool that allows you to build, test, and deploy your code in a standardized way. It is a self-hosted solution built on top of [Dagger](https://dagger.io/), [Wasm](https://webassembly.org) and [Deno](https://deno.land/), can be run locally or on a server, and is completely free and open-source.
1313

14-
It is also a registry of pre-built pipelines that you can use to build, test, and deploy your code. This means you don't have to write your CI/CD configuration from scratch. You can simply search for and use pipelines that others have already built for frameworks like Django, React, Node, etc.
14+
It is also a registry of pre-built pipelines that you can use to build, test, and deploy your code. This means you don't have to write your CI/CD configuration from scratch. You can simply search for and use pipelines that others have already built for different projects like Java, React, Node, Deno etc.
1515

1616
## Why Fluent CI?
1717

1818
Fluent CI is a great choice for your CI/CD needs because it is:
1919

20-
- **Easy to use**: built on top of [Dagger](https://dagger.io/) and [Wasm](https://webassembly.org/), you can easily write and run pipelines in Typescript/Rust or any other language that compiles to Wasm.
21-
22-
- **Web-based UI**: you can easily set up and manage your pipelines using a web-based UI (FluentCI Studio).
20+
- **Local first**: you can start using Fluent CI locally on your machine, and then export your pipelines to your CI Provider (Github Actions, Gitlab CI, Azure Pipelines, AWS CodePipeline, etc.) when you are ready.
2321

24-
- **Self-hosted**: self-hosted solution, which means you can run it locally or on a server. This gives you complete control over your CI/CD process. No need to rely on third-party services like GitHub Actions, GitLab CI, etc.
22+
- **Web-based UI**: you can easily set up and manage your pipelines using a web-based UI ([FluentCI Studio](/category/fluentci-studio/intro)).
23+
24+
- **Consistent**: designed to be consistent across all platforms, you can run the same pipeline locally and on your CI Provider without any changes.
2525

26+
- **Easy to use**: built on top of [Dagger](https://dagger.io/) and [Wasm](https://webassembly.org/), you can easily write and run pipelines in Typescript/Rust or any other language that compiles to Wasm.
27+
2628
- **Free and open-source**: completely free and open-source, you can use it for any purpose, commercial or non-commercial, without any restrictions.
2729

2830
- **Extensible**: you can easily extend Fluent CI to meet your specific needs.
@@ -34,4 +36,4 @@ All Fluent CI pipelines are written in Typescript ([Deno](https://deno.com/)) /
3436
And all pipelines will be executed :
3537

3638
- by [Dagger](https://dagger.io/) in a Docker container, you can easily run them locally or on a server, any platform that supports Docker.
37-
- Or by [FluentCI Engine](https://github.com/fluentci-io/fluentci-engine) in a isolated environment directly on your host machine (thanks to Nix, Pkgx, Flox, Devbox, Devenv, Mise, etc.), for Wasm based Pipelines.
39+
- Or by [FluentCI Engine](https://github.com/fluentci-io/fluentci-engine) in an isolated environment directly on your host machine (thanks to Nix, Pkgx, Flox, Devbox, Devenv, Mise, etc.), for Wasm based Pipelines.

docs/tutorial-basics/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ curl -fsSL https://cli.fluentci.io | bash
3737
You can also install fluentci using [Homebrew](https://brew.sh/):
3838

3939
```bash
40-
brew install fluentci-io/tap/cli
40+
brew install fluentci-io/tap/fluentci
4141
```
4242

4343
### Pkgx

docs/tutorial-extras/_category_.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"label": "Configuring your project",
3-
"position": 3,
2+
"label": "Cookbook",
3+
"position": 2,
44
"link": {
55
"type": "generated-index"
66
}

docs/tutorial-extras/build-bun.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Build and test Bun applications
6+
7+
This guide will show you how to build and test Bun applications with FluentCI.
8+
9+
## Before you begin
10+
11+
The instructions on this page assume that you are familiar with `Bun`. In addition:
12+
13+
- Have your `Bun` project handy, including `package.json` and `test` files.
14+
15+
## Using the Bun Plugin
16+
17+
You can use FluentCI to build Bun applications using [bun plugin](https://github.com/fluent-ci-templates/bun-pipeline), no need to install Bun your machine, FluentCI will handle everything for you.
18+
19+
The following commands can be used to build and test Bun applications:
20+
21+
```bash
22+
fluentci run --wasm bun test
23+
fluentci run --wasm bun build
24+
```
25+
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Build Container Images
6+
7+
This page explains how to build container images for your applications using FluentCI.
8+
9+
## Before you begin
10+
11+
The instructions on this page assume that you are familiar with `Docker`. In addition:
12+
13+
- Have Docker installed on your machine.
14+
- Have your application source code along with `Dockerfile` handy.
15+
16+
## Using the Buildx Plugin
17+
18+
You can use FluentCI to build container images using the [buildx plugin](https://github.com/tsirysndr/daggerverse/tree/main/buildx), no need to install buildx on your machine, FluentCI will handle everything for you.
19+
20+
The following command can be used to build container images:
21+
22+
```bash
23+
fluentci run --wasm buildx build --platform linux/amd64,linux/arm64 -t demo:latest .
24+
```
25+
26+
## Using the Nixpacks Plugin
27+
28+
You can use FluentCI to build container images using the [nixpacks plugin](https://github.com/tsirysndr/daggerverse/tree/main/nixpacks), no need to install nixpacks on your machine, FluentCI will handle everything for you.
29+
30+
The following command can be used to plan and build container image:
31+
32+
```bash
33+
fluentci run --wasm nixpacks nixpacks plan . --format json
34+
fluentci run --wasm nixpacks nixpacks build . --name myapp
35+
```

docs/tutorial-extras/build-deno.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Build and test Deno applications
6+
7+
This page explains how to build and test Deno applications with FluentCI.
8+
9+
## Before you begin
10+
11+
The instructions on this page assume that you are familiar with `Deno`. In addition:
12+
13+
- Have your `Deno` project handy, including `deno.json` and `test` files.
14+
15+
## Using the Deno Plugin
16+
17+
You can use FluentCI to build Deno applications using [deno plugin](https://github.com/fluent-ci-templates/deno-pipeline), no need to install Deno on your machine, FluentCI will handle everything for you.
18+
19+
The following commands can be used to build and test Deno applications:
20+
21+
```bash
22+
fluentci run --wasm deno test
23+
fluentci run --wasm deno compile -A --output myapp --target x86_64-unknown-linux-gnu main.ts # suppose main.ts is your entry file
24+
```
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
5+
# Build and test Flutter applications
6+
7+
This guide will help you build and test Flutter applications with FluentCI.
8+
9+
## Before you begin
10+
11+
The instructions on this page assume that you are familiar with `Flutter`. In addition:
12+
13+
- Be familiar with creating Flutter-based applications.
14+
- Have your Flutter project ready.
15+
16+
## Using the Flutter Plugin
17+
18+
You can use FluentCI to build and test Flutter applications using the [flutter plugin](https://github.com/fluent-ci-templates/flutter-pipeline), no need to install Flutter on your machine, FluentCI will handle everything for you.
19+
20+
The following commands can be used to build and test Flutter applications:
21+
22+
```bash
23+
fluentci run --wasm flutter code_quality
24+
fluentci run --wasm flutter test
25+
fluentci run --wasm flutter build
26+
```
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
# Build and test Gleam applications
6+
7+
This page explains how to build and test Gleam applications with FluentCI.
8+
9+
## Before you begin
10+
11+
The instructions on this page assume that you are familiar with `Gleam`. In addition:
12+
13+
- Be familiar with creating Gleam-based applications.
14+
- Have your Gleam project ready.
15+
16+
## Using the Gleam Plugin
17+
18+
You can use FluentCI to build and test Gleam applications using the [gleam plugin](https://github.com/fluent-ci-templates/gleam-pipeline), no need to install Gleam on your machine, FluentCI will handle everything for you.
19+
20+
The following commands can be used to build and test Gleam applications:
21+
22+
```bash
23+
fluentci run --wasm gleam test
24+
fluentci run --wasm gleam build
25+
```
26+

docs/tutorial-extras/build-go.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
sidebar_position: 6
3+
---
4+
5+
# Build and test Go applications
6+
7+
This page explains how to FluentCI to build and test Go applications.
8+
9+
## Before you begin
10+
11+
The instructions on this page assume that you are familiar with `Go`. In addition:
12+
13+
- Have your Go project handy.
14+
15+
## Using the Go Plugin
16+
17+
You can use FluentCI to build and test Go applications using the [go plugin](https://github.com/fluent-ci-templates/go-pipeline), no need to install Go on your machine, FluentCI will handle everything for you.
18+
19+
The following commands can be used to build and test Go applications:
20+
21+
```bash
22+
fluentci run --wasm go test
23+
fluentci run --wasm go build
24+
```

0 commit comments

Comments
 (0)