flecks/website/docs/configuration.mdx

42 lines
1.2 KiB
Plaintext
Raw Normal View History

2023-12-31 16:23:28 -06:00
---
title: Configuration
2024-01-03 16:14:01 -06:00
description: Configure `build/flecks.yml` and your application.
2023-12-31 16:23:28 -06:00
---
2024-01-03 16:14:01 -06:00
# Configuration
2024-01-04 18:39:21 -06:00
You have a flecks application! ...but it doesn't do much. By default, your application will have
only two flecks:
2024-01-03 16:14:01 -06:00
`@flecks/core` and `@flecks/server`. Your `build/flecks.yml` file will look like this:
2024-01-04 03:23:04 -06:00
```yml title="build/flecks.yml"
2024-01-03 16:14:01 -06:00
'@flecks/core': {}
'@flecks/server': {}
```
Each fleck may have configuration that can be set through `build/flecks.yml`.
For a deep dive of configurable core flecks, see
[the generated configuration page](/docs/flecks/@flecks/dox/config).
2023-12-31 16:23:28 -06:00
2024-01-03 16:14:01 -06:00
## `build/flecks.yml`
2023-12-31 16:23:28 -06:00
2024-01-04 18:39:21 -06:00
Your flecks application stores its build configuration in a directory located at `build`. By
default, there is a single file located there: `flecks.yml`. This is where all the individual
flecks are configured.
2023-12-31 16:23:28 -06:00
2024-01-04 18:39:21 -06:00
Your application's ID is configured at the `id` key of `@flecks/core`'s configuration:
2023-12-31 16:23:28 -06:00
2024-01-04 03:23:04 -06:00
```yml title="build/flecks.yml"
2023-12-31 16:23:28 -06:00
// highlight-start
'@flecks/core':
2024-01-04 18:39:21 -06:00
id: 'hello-world'
2023-12-31 16:23:28 -06:00
// highlight-end
'@flecks/server': {}
```
2024-01-04 18:39:21 -06:00
Notice that the ID was set automatically by the app creation utility.
2023-12-31 16:23:28 -06:00
2024-01-04 18:39:21 -06:00
## Moving forward
2023-12-31 16:23:28 -06:00
2024-01-04 18:39:21 -06:00
In the next section, we'll look at how to create a fleck.