Skip to content

Commit 3b9f92e

Browse files
committed
style: make docs more concise
1 parent a082ec4 commit 3b9f92e

File tree

2 files changed

+17
-22
lines changed

2 files changed

+17
-22
lines changed
File renamed without changes.

README.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,40 @@
1-
# meuCafeList
1+
## meuCafeList
2+
[![slimjre](https://github.com/deomorxsy/meuCafeList/actions/workflows/slimjre_ci.yml/badge.svg)](https://github.com/deomorxsy/meuCafeList/actions/workflows/slimjre_ci.yml)
3+
[![wasm-yew](https://github.com/deomorxsy/meuCafeList/actions/workflows/wasm_ci.yml/badge.svg)](https://github.com/deomorxsy/meuCafeList/actions/workflows/wasm_ci.yml)
24

3-
A speedrun attempt to clone [MAL](https://myanimelist.net/) lists into a github pages subdomain, using SpringBoot. IaC automation provided by OCI containers, compose, github actions and scaffolding with shellscript.
4-
5-
The second attempt is to make the app ~**blazingly**~ fast by having a slim container image build, featuring:
6-
- alpine as OCI container distro;
5+
Featuring:
6+
- Alpine as OCI container distro;
77
- [corretto-22](https://hub.docker.com/_/amazoncorretto) as JRE;
8-
- symbol stripping with [jlink](https://docs.oracle.com/en/java/javase/17/docs/specs/man/jlink.html);
9-
- multi-stage builds to avoid container layer bloat.
8+
- Symbol stripping with [jlink](https://docs.oracle.com/en/java/javase/17/docs/specs/man/jlink.html);
9+
- Multi-stage builds to avoid container layer bloat.
1010
- TDD (Test-Driven-Development) is implemented on build on a layer that will be discarded from the final production image, which will contain the artifact.
11+
- yew-rs serving wasm with trunk/wasm-packer
1112

12-
## Usage
13+
### Usage
1314

1415
1. clone repository with SSH and enter directory
1516
```sh
1617
git clone [email protected]:deomorxsy/meuCafeList.git
1718
cd ./meuCafeList/
1819
```
20+
2. Build with **make build**
1921

20-
2. **make build** to build with:
21-
```sh
22-
mvn compile exec:java -Dexec.mainClass="com.meucafelist.app.App"
23-
```
24-
3. **make test** to test the app.
25-
26-
4. **make up/down** to respectively run or stop the app.
22+
3. Test with **make test**
2723

28-
5. general infra debugging
29-
- [util-linux/sys-utils](https://github.com/util-linux/util-linux/tree/master/sys-utils) namespaces related tools
24+
4. Run/Stop the app: **make up/down**
3025

31-
## Scaffolding
26+
### Scaffolding
3227

33-
1. **make scaff** to run [setup.sh](./scripts/skel.sh) and generate the project skeleton directory structure:
28+
1. **make scaff** to run [setup.sh](./scripts/skel.sh) and generate a similar project directory structure
3429

35-
## Deployment
30+
### Deployment
3631

3732
This repository uses Github Actions for Continuous Integration. Similar to how to run manually, the [yaml script](./.github/workflows/ci.yml) calls Makefile, which calls compose.yml, which runs the containers based on the specific Dockerfile context. It consists in three containers:
3833
- server: the SpringBoot application on a slim JRE with amazon-corretto and the Alpine distro.
3934
- client: the Yew application frontend on a slim Rust environment. [This](./client/Dockerfile) multi-stage build was inspired by codefeetime's [article](https://www.codefeetime.com/post/docker-config-for-actix-web-diesel-and-postgres/).
4035
- nginx as web server, reverse proxy, etc.
4136

42-
### compose (+ Podman Service)
37+
#### compose (+ Podman Service)
4338

4439
Compose concentrates in orchestrating multiple containers in a single host. To do this with k8s, you would need [kind](https://kind.sigs.k8s.io/), [minikube](https://minikube.sigs.k8s.io/docs/start/), [k3s](https://k3s.io/) (does not use virtualization) or similar. It was made to be compatible with other OCI runtimes, such as Podman, which was one of the first to enable rootless containers, and can be setup with compose using the Podman Service's systemd unit file for unix sockets.
4540

@@ -51,7 +46,7 @@ Source the script and run it to run compose with podman, or just put a ```make u
5146
; source ./scripts/ccr.sh; checker
5247
```
5348

54-
### k8s
49+
#### k8s
5550

5651
Kubernetes is a container orchestrator that have a YAML syntax similar to the CI deployment from this repo. To run this project on single host just like the Compose tool, you can use tools like kind or minikube in a full-virtualized environment or k3s which don't use full-virtualization. The cluster setup such as ingress and egress will not be covered here.
5752

0 commit comments

Comments
 (0)