Skip to content

Commit

Permalink
Extend readme to include jobs
Browse files Browse the repository at this point in the history
  • Loading branch information
minottic committed Nov 21, 2024
1 parent 0d33e63 commit 0204fba
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ This project requires docker and docker compose. The docker version must be late

Release `v3.0` is the first stable and reviewed version of SciCatLive.

## Create the release-jobs DEV environment

To start the containers in DEV mode with JOBS settings, set the env variables `DEV=true` and `JOBS_ENABLED=true` [here](.env). This will start the backend and the frontend in development mode with code checkout out at `#release-jobs` branch, including the requirements to run tests.

## Steps

<details markdown="1">
Expand Down
5 changes: 5 additions & 0 deletions services/backend/services/v4/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ If `OIDC_ENABLED` is toggled, you can use OIDC to log in with a [OIDC user](../k

With `DEV=true`, since the container might have limited memory, it is recommended to run unit tests with the option `--runInBand`, as [here](./entrypoints/tests.sh), which makes the tests run sequentially, avoiding to fill the RAM which makes them freeze.

With `DEV=true` and `JOBS_ENABLED=true` containers in `DEV` mode is created with code checkout out at `#release-jobs` branch, in a dedicated docker volume: `v4_jobs_dev`. As docker caches images, it is recommended to run `npm install` whenever rerunning `docker compose up -d`, or rebuild the image without cache with:
```bash
docker compose up -d --build
```

## Dependencies

Here below we show the internal dependencies of the service, which are not already covered [here](../../../../README.md) and [here](../../README.md) (if `B` depends on `A`, then we visualize as `A --> B`). The same subdomain to service convention applies.
Expand Down
5 changes: 5 additions & 0 deletions services/frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ Since there was a small breaking change from `v3` to `v4`, when connecting to th

With `DEV=true`, please use `npm start -- --host 0.0.0.0`. This is to allow traffic from any IP to the `frontend` component and it is necessary since the component runs in the docker network.

With `DEV=true` and `JOBS_ENABLED=true` containers in `DEV` mode is created with code checkout out at `#release-jobs` branch, in a dedicated docker volume: `frontend_jobs_dev`. As docker caches images, it is recommended to run `npm install` whenever rerunning `docker compose up -d`, or rebuild the image without cache with:
```bash
docker compose up -d --build
```

Setting the [BACKEND_HTTPS_URL env variable](../../.env) requires changing the `backend` URL used by the `frontend`. This is managed [here](../../entrypoints/merge_json.sh).

:warning: When setting `FRONTENT_HTTPS_URL` it is likely you also want to set the `BACKEND_HTTPS_URL`, to allow the communication between the two wherever the browser is accessed.

0 comments on commit 0204fba

Please sign in to comment.