From 39f6fe49d1672adbb11a378925d36894ab712235 Mon Sep 17 00:00:00 2001 From: counterweight Date: Fri, 21 Feb 2025 16:56:58 +0100 Subject: [PATCH] update readme --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9b9208e..5304cfb 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,19 @@ -# Express hello world +# laseca -A joke application. +laseca is a social bitcoin to cash exchange, implemented as a webapp. ## How to set up dev environment * Pre-requisites + `docker` and `docker compose` + `node` and `npm` -* Run `npm install` -* You can now start the app in a container by running `npm run start:containers` (and shut it down with `npm run stop:containers`). - -## How to test - -* Run `npm run test` +* Installing + + Run `npm install` + + You can now start the app in a container by running `npm run start:containers` (and shut it down with `npm run stop:containers`). +* Running + + The app will run in a single container, with a Postgres database, a caddy webserver and the nodejs app. + + Note that the container doesn't come with a volume for Postgres: default behaviour is to start from scratch every time you create the container, delete everything every time you delete the container. + + The docker image launches the nodejs app with nodemon, so changes to the code will be available immediately. ## How to deploy