update readme
This commit is contained in:
parent
a3ca2636e1
commit
39f6fe49d1
1 changed files with 9 additions and 8 deletions
17
README.md
17
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
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue