72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
# Visitenbuch
|
|
|
|
for the university hospital in Augsburg
|
|
|
|
## Development
|
|
|
|
The project template was created using
|
|
[`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
|
|
|
|
Once you've created a project and installed dependencies with `npm install` (or
|
|
`pnpm install` or `yarn`), start a development server:
|
|
|
|
```bash
|
|
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.
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
pnpm run build
|
|
```
|
|
|
|
You can preview the production build with `npm run preview`.
|
|
|
|
> To deploy your app, you may need to install an
|
|
> [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
|
|
|
|
### Test
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
./release.sh 1.0.0
|
|
```
|
|
|
|
### Building docker image
|
|
|
|
```bash
|
|
pnpm run build
|
|
docker build -t thetadev256/visitenbuch .
|
|
```
|