Rocky
Rocky is part of the openKAT project, made with Django.
Stack
Django is the framework for this project. To comply to government standards, use Manon for style and accessibility. Yarn is used as package manager and ParcelJS is used as bundler to compile the frontend (CSS and Javascript). You can find the Manon repository here: https://github.com/minvws/nl-rdo-manon
Running Rocky
Containerized
To run rocky from the docker container, from the parent directory nl-kat-coordination
, just run:
$ make kat
and continue reading this document at “First run”.
Locally
To run rocky locally, follow these steps.
Installation
Yarn is used to bundle CSS and Javascript. You can build Rocky locally using:
$ make build
This will set up Django and compile the frontend.
Running
You can run Rocky using:
$ make run
First run
After running the first time, visit localhost:8000 in your browser. Log in with credentials: admin / admin
You will be prompted to create secure your account with a One Time Password, so get your authenticator ready.
Testing
To run all tests, run:
$ make test
Database
To connect to the PostgreSQL database, set the following environment variables (e.g. “localhost”, “5432” etc.):
ROCKY_DB_HOST=
ROCKY_DB_PORT=
ROCKY_DB=
ROCKY_DB_USER=
ROCKY_DB_PASSWORD=
ROCKY_DB_DSN=
The ROCKY_DB_DSN
is optional (e.g. postgresql://username:password@hostname:port/database_name
) and if unset the other DB variables will be used to setup the database connection.
Fonts license
All fonts used within Rocky remain under their own license. For example: Fredoka, Open Sans & Tabler icons.
For more information check their respective folders for extra/ more specific license (if available) or visit:
Fredoka
https://fonts.google.com/specimen/Fredoka/about
Open Sans
https://fonts.google.com/specimen/Open+Sans/about
Tabler icons
https://tabler-icons.io/
Rocky Design
Running a boefje
The following diagram shows the triggered flows when running a Boefje from Rocky.
Rocky View Structure
Rocky has a hierarchical set of views that are not easy to capture in a single diagram. We therefore made several diagrams to show the most coherent components.
Overview of child Views of the OrganizationViews
Exhaustive overview of OctopoesViews
KATalogus Views
This diagram shows the current view structure and what properties are set in each class for the KATalogus.