damianobarbati / webapp-be

webapp-be

Starter kit for backend of web applications.

Development

Set variables in .env file then start development environment:

nvm install
yarn install
yarn serve

Development database

Load environment variables:

source .env

Start database:

docker run --name ${PG_DATABASE:?}-db \
  --restart=always -d \
  -e POSTGRES_USER=${PG_USER:?} \
  -e POSTGRES_PASSWORD=${PG_PASSWORD:?} \
  -e POSTGRES_DB=${PG_DATABASE:?} \
  -e POSTGRES_OPTIONS="-c log_statement=all" \
  -p 5432:5432 \
  postgres:14-alpine

Connect to database:

docker exec -ti ${PG_DATABASE:?}-db psql ${DB_URI:?}

Import schema:

cat database/0-funcs.sql database/1-schema.sql | docker exec -i ${PG_DATABASE:?}-db psql ${DB_URI:?}

Dump database:

docker exec -ti \
  -e POSTGRES_USER=${PG_USER:?} \
  -e POSTGRES_PASSWORD=${PG_PASSWORD:?} \
  -e POSTGRES_DB=${PG_DATABASE:?} \
  ${PG_DATABASE:?}-db \
  pg_dump --clean -U ${PG_USER:?} ${PG_DATABASE:?} > database/dump.sql # schema and data

Deployment

CI is powered by GitHub actions (.github folder):

• PR on main branch are tested but not deployed to any environment
• commits on main branch are deployed to staging environment
• tags on main branch are deployed to production environment

webapp-be's Issues

data validation

@mello (aka @emilioSp) I'm still opting out of typescript, which anyway do not fill the purpose since a json input to the webserver will not respect any code annotion.

What's the best (aka cost-effective less-complex) solution for data validation right now?

I was going to give ajv a try.

[fix] node/no-missing-import

@emilioSp in .eslintrc the rule node/no-missing-import": "off" was disabled because jest file can't resolve extensions properly. WTF?

[fix] various fixes necessary

• .run folder should contain a run used by default when running a standalone script
• tests are broken in CLI but they are working in webstorm debugger