services-flake/doc/index.md

34 lines
981 B
Markdown
Raw Normal View History

2024-01-14 12:04:37 +03:00
---
short-title: services-flake
template:
sidebar:
collapsed: true
emanote:
folder-folgezettel: false
---
# Running services using `services-flake`
2024-06-15 17:10:05 +03:00
[services-flake][gh] provides declarative, composable, and reproducible services for Nix development environment, as a [process-compose-flake](https://github.com/Platonic-Systems/process-compose-flake) module (based on [flake-parts](https://flake.parts)). It enables users to have NixOS-like services on MacOS and Linux.
2024-01-14 12:04:37 +03:00
It builds on top of the [process-compose-flake](https://community.flake.parts/process-compose-flake) module which allows running arbitrary processes declared in Nix.
2024-01-14 12:04:37 +03:00
See:
2024-03-20 21:57:36 +03:00
- [[start]]#
2024-03-20 21:57:36 +03:00
- [[examples]]#
- [[services]]#
- [[contributing]]#
- [[guide]]#
## Demo
This is how running a service with `services-flake` looks like[^demo]:
:::{.max-w-2xl .h-auto .mx-auto .p-4}
![[demo.gif]]
:::
2024-03-07 23:34:34 +03:00
[^demo]: The commands used in the demo are available [[start]].
2024-01-14 12:04:37 +03:00
[gh]: https://github.com/juspay/services-flake