oscarmlage/wrappd.sh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imp: README

Browse Source
This commit is contained in:
Óscar M. Lage 2024-12-05 14:14:20 +01:00
parent 6a7c97538f
commit ae0ef08f9b
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -14,8 +14,11 @@ $ cp env.sample .env
```ini ```ini
# Docker # Docker
DOCKER_ENV=production DOCKER_ENV=production
PROJECT_NAME=heating-monitor BASE_URL=https://wrap.sh
FIXME SERVER_PORT=8080
UPLOAD_DIR=uploads
TOP_N_COMMANDS=10
MASTODON_INSTANCE_FOR_SHARING=mastodon.social
``` ```
## Docker ## Docker
@ -26,13 +29,14 @@ This project can be easily run on Docker:
$ make build $ make build
$ make rebuild $ make rebuild
$ make start $ make start
$ make stop
``` ```
The `Makefile` has been configured to facilitate the build and execution of Docker with the `--build-arg` argument, which passes the `DOCKER_ENV` environment variable to determine the environment. This variable is read from the .env file: The `Makefile` has been configured to facilitate the build and execution of Docker with the `--build-arg` argument, which passes the `DOCKER_ENV` environment variable to determine the environment. This variable is read from the .env file:
`--build-arg DOCKER_ENV=${DOCKER_ENV}`: This variable is used to determine the execution environment (`local` or `production`), affecting both the binary build process and the container's behavior. `--build-arg DOCKER_ENV=${DOCKER_ENV}`: This variable is used to determine the execution environment (`local` or `production`), affecting both the binary build process and the container's behavior.
If `DOCKER_ENV` is set to `production` it should execute the binary, whereas if set to `local` it will run with air to enable reloads during development, among other things. If `DOCKER_ENV` is set to `production` it should execute the binary, whereas if set to `local` it will install and run with `air` to enable reloads during development, among other things.
## Comands ## Comands