README

This repository contains the source code for the blog post "Remix—Ein leichtgewichtiger Ansatz für Geschäftsanwendungen".

Prerequisites

• Docker

• Node.js (>= 20)

• yarn

Preparing .env

Before doing anyting else use the env.sample to seed your .env

cp env.sample .env

And link to the .env from the chinook directory (or copy .env there as well)

cd chinook
ln -s ../.env .env

Getting Started development

Now start the postgres container using docker in the root directory of the project.

docker compose up -d

Then install the dependencies and start the application (in the chinook subdirectory)

yarn install
yarn dev

The application is now available at http://localhost:5173.

Show me the app

If you only want to see the app, you can use the following command to start the app in a docker container.

docker compose --profile up -d

The application is available at http://localhost:8080

Running the tests

Currently, this demo project does not contain many tests. However, it has the test infrastructure in place for unit, integration, and end-to-end tests.

It uses vitest for running the tests, the testing-library for the integration tests, and playwright for the end-to-end tests. It also makes use of Remix’s testing utilities.

To run the unit tests, execute the following command:

yarn test

To run the End-2-End tests, execute the following command:

yarn test:e2e

Regenerate the documentation

The documentation is generated using Antora. Because of the diagram generation, you need kroki running on your machine. We wanted to showcase a local installation of kroki, so we did not use the hosted version. Often documentation should not leave the company network, so this is a good approach. For this public repository, we could have used the hosted version.

Therefore, you need to start kroki in the root directory of the project.

docker compose --profile doc up -d

Then you can generate the documentation using the following command in the docs directory.

yarn install
yarn antora:generate

If you start the application, the documentation is available at http://localhost:5173/docs.