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. Run it to see what a portal on these libraries does, or copy it to start your own.

  • ichec-django-core, on PyPI, is the backend. It provides 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 provides pages to list, view, create and edit, and talks to the API through a client generated from the backend's schema.yaml.

What ichec-django-core provides: workflows, forms, files, people, sign-in, background tasks and a 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/. docs/development.md says how to run the backend's checks, and the frontend's README has its own.

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.2

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.2
File Size Uploaded Provenance Actions
ichec_django_core-8.6.2.tar.gz 413.6 kB Without provenance Details for ichec_django_core-8.6.2.tar.gz

Built distribution (wheel)

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

Total release size: 769.4 kB

Release files / ichec_django_core-8.6.2.tar.gz

Download URL ichec_django_core-8.6.2.tar.gz
Size 413.6 kB
Tags Source
SHA-256 checksum
How to use checksums
c8a4a7d82eb012c1562edb22f64e42ff68b83f0983011b951d76e0d8f0e867bf
BLAKE2b-256 checksum
How to use checksums
c2546b98ad3bb9a6686d5b529a0a2675aefeb67f800a9e8abcaf296f9f7688e5
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.2-py3-none-any.whl

Download URL ichec_django_core-8.6.2-py3-none-any.whl
Size 355.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9a07a27642cabc241593399485c631bc370833cf8645c89fb2d2e0abd21ba963
BLAKE2b-256 checksum
How to use checksums
038410181671c5f05e7fea3f9f1c282a66996988048bbaefa20b89e43420ff4f
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.2

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.2 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