Visitenbuch/README.md
ThetaDev 297f5cfa92
All checks were successful
Visitenbuch CI / test (push) Successful in 2m20s
Visitenbuch CI / release (push) Has been skipped
update README
2024-05-21 03:58:13 +02:00

1.7 KiB

Visitenbuch

for the university hospital in Augsburg

Development

The project template was created using create-svelte.

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

pnpm run dev

# or start the server and open the app in a new browser tab
pnpm run dev -- --open

Test environment

Copy the .env.example file to .env to get access to the required configuration variables.

The project depends on a PostgreSQL database and an OIDC authentication server. You can setup both using the run/db_up.sh script. This creates a new testing environment using docker-compose and fills the test database with mock data.

Use the Pisma ORM

If you apply changes to the database scheme, you have to create a new migration to apply these changes to the database.

npx prisma migrate dev --name my_migration --create-only # Create a new migration
npx prisma migrate dev # Apply migrations to the database

Building

To create a production version of your app:

pnpm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Test

pnpm test # Unit- und Integrationstests
pnpm test:e2e # End2End-Tests

Release

To release a new version, tun the release script with the new version as a parameter

./release.sh 1.0.0

Building docker image

pnpm run build
docker build -t thetadev256/visitenbuch .