IT4Change/Ocelot-Social
3
0
Fork 0
mirror of https://github.com/IT4Change/Ocelot-Social.git synced 2025-12-13 07:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(docu): update email snapshots (#8514)

Browse Source
This commit is contained in:
Moriz Wahl 2025-05-09 14:21:18 +02:00 committed by GitHub
parent b471a8f92b
commit ca5b1fa0b5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
backend/README.md
View File

@ -87,9 +87,9 @@ A fresh database needs to be initialized and migrated.
# in folder backend while database is running # in folder backend while database is running
yarn db:migrate init yarn db:migrate init
# for docker environments: # for docker environments:
docker exec backend yarn db:migrate init docker exec ocelot-social-backend-1 yarn db:migrate init
# for docker production: # for docker production:
docker exec backend yarn prod:migrate init docker exec ocelot-social-backend-1 yarn prod:migrate init
``` ```
```sh ```sh
@ -97,9 +97,9 @@ docker exec backend yarn prod:migrate init
yarn db:migrate up yarn db:migrate up
# for docker development: # for docker development:
docker exec backend yarn db:migrate up docker exec ocelot-social-backend-1 yarn db:migrate up
# for docker production # for docker production
docker exec backend yarn prod:migrate up docker exec ocelot-social-backend-1 yarn prod:migrate up
``` ```
### Optional Data ### Optional Data
@ -131,7 +131,7 @@ To do so, run:
yarn db:data:branding yarn db:data:branding
# for docker # for docker
docker exec backend yarn db:data:branding docker exec ocelot-social-backend-1 yarn db:data:branding
``` ```
### Seed Data ### Seed Data
@ -143,7 +143,7 @@ For a predefined set of test data you can seed the database with:
yarn db:seed yarn db:seed
# for docker # for docker
docker exec backend yarn db:seed docker exec ocelot-social-backend-1 yarn db:seed
``` ```
### Reset Data ### Reset Data
@ -157,9 +157,9 @@ yarn db:reset
yarn db:reset:withmigrations yarn db:reset:withmigrations
# for docker # for docker
docker exec backend yarn db:reset docker exec ocelot-social-backend-1 yarn db:reset
# or deleting the migrations as well # or deleting the migrations as well
docker exec backend yarn db:reset:withmigrations docker exec ocelot-social-backend-1 yarn db:reset:withmigrations
# you could also wipe out your neo4j database and delete all volumes with: # you could also wipe out your neo4j database and delete all volumes with:
docker compose down -v docker compose down -v
``` ```
@ -180,7 +180,7 @@ $ yarn run db:migrate:create your_data_migration
# for docker # for docker
# in main folder while docker compose is running # in main folder while docker compose is running
$ docker compose exec backend yarn run db:migrate:create your_data_migration $ docker compose exec ocelot-social-backend-1 yarn run db:migrate:create your_data_migration
# Edit the file in ./src/db/migrations/ # Edit the file in ./src/db/migrations/
``` ```
@ -208,5 +208,12 @@ $ yarn run test
# for docker # for docker
# in main folder while docker compose is running # in main folder while docker compose is running
$ docker exec backend yarn run test $ docker exec ocelot-social-backend-1 yarn run test
```
If the snapshots of the emails must be updated, you have to run the tests in docker! Otherwise the CI will fail.
```sh
# in main folder while docker compose is running
$ docker exec ocelot-social-backend-1 yarn run test -u src/emails/
``` ```