Skip to main content

ICHEC Web

ICHEC Web is the reference ICHEC web portal. It is a working portal you can run on your machine with one command, and the two libraries it is built from. Use it to see what an ICHEC portal gives you, and as the starting point for your own.

  • ichec-django-core, on PyPI, is the backend. It gives a portal secure settings, members and organisations, sign-in through Keycloak, permissions, forms, workflows and a REST API.
  • ichec-angular-core, on npm, is the frontend. It gives a portal pages to list, view, create and edit, and talks to the API through a client generated from the backend's schema.yaml.

The portal's building blocks: workflows, forms, files, people, sign-in and background tasks over a secure foundation, all through a standards-based REST API

Try the portal

You need Docker, or Podman with podman compose.

git clone https://git.ichec.ie/platform-engineering/modules/ichec-web.git
cd ichec-web
cp .env.example .env
docker compose up -d

The first start builds the portal, which takes several minutes. Then open http://localhost:8080/ and sign in as admin, password admin. http://localhost:8080/api/ is the API, and http://localhost:8025/ shows the emails the portal sends. docker compose down -v stops it and deletes its data.

The portal's backend is in app/, and its frontend is the test app in frontend/projects/test-app.

Build your own portal

A portal of your own uses the two libraries from PyPI and npm, and adds its own models, pages and rules. Build each side with its guide:

The example portal shows the result: app/settings.py for the backend, and the test app's app.config.ts for the frontend.

Deploy a portal

The sample web portal deploys a portal built on these libraries to a server, with HTTPS, Keycloak and backups, using the ichec.platform Ansible collection. Start there when your portal is ready to run somewhere other than your machine.

Work on this repo

The backend is at the top of the repo, and the frontend in frontend/. CI runs each side's checks only when that side changes, and both when schema.yaml changes. The frontend's README has its checks. For the backend, install the development tools and run the checks that CI runs:

uv sync --group dev --extra async
uv run pytest
uv run ruff format --check .
uv run ruff check .
uv run mypy src

The tests run on SQLite locally, and on Postgres 18 in CI, as production runs it. Postgres finds faults that SQLite hides, such as a foreign key to a table that doesn't exist yet. To run them on Postgres, start a server and run the postgres env:

podman run -d --rm --name ichec-test-postgres -p 5432:5432 -e POSTGRES_PASSWORD=password postgres:18
uv run tox -e postgres

DJANGO_SQL_HOST, DJANGO_SQL_PORT, DJANGO_SQL_USER and DJANGO_SQL_PASSWORD point it at another server.

If you use direnv, run direnv allow once and the environment activates when you enter the directory.

The messages check needs GNU gettext (brew install gettext). If you add or change a string people read, mark it for translation, and update the catalogue with uv run tox -e messages, and commit it. An app can check its own catalogue the same way, with python manage.py check_messages -l <code> run from its package.

If you change a model or serializer, regenerate the API schema and both clients, and commit them:

uv run python manage.py generate_client ichec_django_core.client
cd frontend && npm run generate

Licence

Copyright of the Irish Centre for High End Computing (ICHEC), released under the MIT License. See LICENSE.

Metadata

Release files for ichec-django-core 8.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ichec-django-core 8.6.1
File Size Uploaded Provenance Actions
ichec_django_core-8.6.1.tar.gz 415.0 kB Without provenance Details for ichec_django_core-8.6.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ichec-django-core 8.6.1
File Interpreter ABI Platform Actions
ichec_django_core-8.6.1-py3-none-any.whl Python 3 none any Details for ichec_django_core-8.6.1-py3-none-any.whl

Total release size: 771.6 kB

Release files / ichec_django_core-8.6.1.tar.gz

Download URL ichec_django_core-8.6.1.tar.gz
Size 415.0 kB
Tags Source
SHA-256 checksum
How to use checksums
51b0c916285722c3864bb987bb0cf3f6207dbde7fac62022054de040acd3a2dc
BLAKE2b-256 checksum
How to use checksums
a21022c390de482f1b91377192b222cb11cc73bdd61f46317c1396ac374c0ffe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / ichec_django_core-8.6.1-py3-none-any.whl

Download URL ichec_django_core-8.6.1-py3-none-any.whl
Size 356.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4dad6a0ebea816c96da5e80b289561f6aa40243e85392d229261bb3d97cf9b57
BLAKE2b-256 checksum
How to use checksums
9dcc9896be23e58dc420907b63b26580ee147d612149edd6898bfe9bcccec53c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for ichec-django-core 8.6.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

8.6.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page