counterweight/secajs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
counterweight 2025-02-21 16:56:58 +01:00
parent a3ca2636e1
commit 39f6fe49d1
Signed by: counterweight
GPG key ID: 883EDBAA726BD96C
1 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -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 ## How to set up dev environment
* Pre-requisites * Pre-requisites
+ `docker` and `docker compose` + `docker` and `docker compose`
+ `node` and `npm` + `node` and `npm`
* Run `npm install` * Installing
* You can now start the app in a container by running `npm run start:containers` (and shut it down with `npm run stop:containers`). + 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 * Running
+ The app will run in a single container, with a Postgres database, a caddy webserver and the nodejs app.
* Run `npm run test` + 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 ## How to deploy