From 54668e06baaed0413714fc7527bc072ee4864716 Mon Sep 17 00:00:00 2001 From: Bruno Bernardino Date: Tue, 8 Oct 2024 14:36:27 +0100 Subject: [PATCH] Update docker compose commands --- .github/workflows/tests.yml | 4 ++-- README.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 58157c3..edbbdee 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -10,11 +10,11 @@ jobs: - uses: denoland/setup-deno@v1 with: deno-version-file: .dvmrc - - run: docker-compose pull + - run: docker compose pull - uses: jpribyl/action-docker-layer-caching@v0.1.1 continue-on-error: true - run: | cp .env.sample .env - docker-compose up -d + docker compose up -d make migrate-db make test diff --git a/README.md b/README.md index 4a798b0..f5e34ad 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![](https://github.com/BrunoBernardino/budgetzen-web/workflows/Run%20Tests/badge.svg)](https://github.com/BrunoBernardino/budgetzen-web/actions?workflow=Run+Tests) -This is the web app for the [Budget Zen app](https://budgetzen.net), built with [Deno](https://deno.land) and deployed using [docker-compose](https://docs.docker.com/compose/). +This is the web app for the [Budget Zen app](https://budgetzen.net), built with [Deno](https://deno.land) and deployed using [docker compose](https://docs.docker.com/compose/). This is v3, which is [end-to-end encrypted with open Web Standards](https://en.wikipedia.org/wiki/End-to-end_encryption), and works via web on any device (it's a PWA - Progressive Web App). @@ -30,7 +30,7 @@ It's meant to have no unnecessary dependencies, packagers, or bundlers. Just van This was tested with [`Deno`](https://deno.land)'s version stated in the `.dvmrc` file, though other versions may work. -For the PostgreSQL dependency (used when running locally, self-hosted, or in CI), you should have `Docker` and `docker-compose` installed. +For the PostgreSQL dependency (used when running locally, self-hosted, or in CI), you should have `Docker` and `docker compose` installed. If you want to run the app locally with SSL (Web Crypto standards require `https` except for Chrome), you can use [`Caddy`](https://caddyserver.com) (there's a `Caddyfile` that proxies `https://localhost` to the Deno app). @@ -39,7 +39,7 @@ Don't forget to set up your `.env` file based on `.env.sample`. ## Development ```sh -$ docker-compose up # (optional) runs docker with postgres, locally +$ docker compose up # (optional) runs docker with postgres, locally $ sudo caddy run # (optional) runs an https proxy for the deno app $ make migrate-db # runs any missing database migrations $ make start # runs the app