Skip to content

Commit d74130c

Browse files
authored
Merge pull request #93 from bozemanpass/dboreham/update-intro
Update intro section
2 parents e170023 + 778bc42 commit d74130c

1 file changed

Lines changed: 18 additions & 11 deletions

File tree

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
# Stack
22

3-
Stack allows building and deployment of a suite of related applications as a single "stack".
3+
Stack allows building and deployment of a system of related containerized applications as a single "stack". Transparently deploy to local Docker, Podman or to remote Kubernetes.
44

55
## Quick Start
66

7+
Let's build and deploy an [example stack](https://github.com/bozemanpass/example-todo-list) for the canonical "Todo" web app (LLM-generated of course).
8+
This stack comprises the web app front-end, an api back-end and its PostgreSQL database.
9+
10+
First we'll deploy to local Docker. Then deploy the same stack to Kubernetes.
11+
712
### Docker
813

914
```
@@ -15,16 +20,17 @@ stack prepare --stack todo
1520
stack init \
1621
--stack todo \
1722
--output todo.yml \
23+
--deploy-to compose \
1824
--map-ports-to-host localhost-same
1925
2026
# create the deployment from the config
21-
stack deploy --spec-file todo.yml --deployment-dir ~/deployments/todo
27+
stack deploy --spec-file todo.yml --deployment-dir ~/deployments/todo-docker
2228
2329
# start / status / logs / stop
24-
stack manage --dir ~/deployments/todo start
25-
stack manage --dir ~/deployments/todo status
26-
stack manage --dir ~/deployments/todo logs
27-
stack manage --dir ~/deployments/todo stop
30+
stack manage --dir ~/deployments/todo-docker start
31+
stack manage --dir ~/deployments/todo-docker status
32+
stack manage --dir ~/deployments/todo-docker logs
33+
stack manage --dir ~/deployments/todo-docker stop
2834
```
2935

3036
### Kubernetes
@@ -47,22 +53,23 @@ stack init \
4753
--config REACT_APP_API_URL=https://example-todo.myexample.com/api/todos
4854
4955
# create the deployment from the config
50-
stack deploy --spec-file todo.yml --deployment-dir ~/deployments/todo
56+
stack deploy --spec-file todo.yml --deployment-dir ~/deployments/todo-k8s
5157
5258
# push image tags for this deployment to the image registry used by Kubernetes
5359
stack manage --dir ~/deployments/todo push-images
5460
5561
# start / status / logs / stop
56-
stack manage --dir ~/deployments/todo start
57-
stack manage --dir ~/deployments/todo status
58-
stack manage --dir ~/deployments/todo logs
59-
stack manage --dir ~/deployments/todo stop
62+
stack manage --dir ~/deployments/todo-k8s start
63+
stack manage --dir ~/deployments/todo-k8s status
64+
stack manage --dir ~/deployments/todo-k8s logs
65+
stack manage --dir ~/deployments/todo-k8s stop
6066
```
6167

6268
## Example Stacks
6369

6470
- [Gitea](https://about.gitea.com/) stack: https://github.com/bozemanpass/gitea-stack
6571
- A [sign in with Ethereum](https://docs.login.xyz/) web app with fixturenet blockchain: https://github.com/bozemanpass/siwe-express-example
72+
- Todo List Web App with back-end: https://github.com/bozemanpass/example-todo-list
6673

6774
## Install
6875

0 commit comments

Comments
 (0)