Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/minvws/nl-kat-rocky
Repo nl-kat-rocky for openkat
https://github.com/minvws/nl-kat-rocky
Last synced: about 1 month ago
JSON representation
Repo nl-kat-rocky for openkat
- Host: GitHub
- URL: https://github.com/minvws/nl-kat-rocky
- Owner: minvws
- License: eupl-1.2
- Created: 2022-06-27T12:50:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-03T10:42:26.000Z (almost 2 years ago)
- Last Synced: 2023-03-04T04:56:57.455Z (almost 2 years ago)
- Language: HTML
- Homepage: https://openkat.nl
- Size: 6.36 MB
- Stars: 7
- Watchers: 17
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
**This repository has been archived because all repositories of the individual
OpenKAT modules have been merged in the main OpenKAT repository at
https://github.com/minvws/nl-kat-coordination**
## Rocky (nl-kat)
Rocky is part of the openKAT project, made with Django.
See [nl-kat-coordination](https://github.com/minvws/nl-kat-coordination) for more details about openKAT.
## Stack
As said, Django is the framework for this project.
To comply to government standards, use [Manon](https://github.com/minvws/nl-rdo-manon) for style and accessibility.
Yarn is used as package manager and ParcelJS is used as bundler to compile the frontend (CSS and Javascript).
For browsertests we are using [Cypress](https://www.cypress.io/).
You can find the Manon repository here: [https://github.com/minvws/nl-rdo-manon](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:
```bash
$ 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:
```bash
$ make build
```
This will set up Django and compile the frontend.
### Running
You can run Rocky using:
```bash
$ make run
```
## First run
After running the first time, visit [localhost:8000](http://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:
```bash
$ make test
```
But first you will need to setup Cypress.
### Setting up Cypress
Cypress is installed in a separate directory `roeltje`.
You will need to run the django command `setup_test_users` to create users and credentials used in cypress
see: [cypress.json](https://github.com/minvws/nl-kat-rocky/blob/develop/roeltje/cypress.json).
```bash
$ python manage.py setup_test_users
$ yarn --cwd roeltje
$ yarn --cwd roeltje cypress open
```
add to 1Password:
```json
otpauth://totp/localhost%3A8000%3A%20admin?secret=TAAVFPQD3C3NLRSZQBD3CJ7ZUVDJXDS5&digits=6&issuer=localhost%3A8000
```
So eventually your `cypress.json` shapes like this:
```json
{
"viewportWidth": 1280,
"viewportHeight": 1024,
"env": {
"base_url": "http://localhost:8000/",
"client_user": "admin",
"client_pass": "admin",
"client_otp_secret": "TAAVFPQD3C3NLRSZQBD3CJ7ZUVDJXDS5"
}
}
```
!! WARNING !! DON'T DO THIS IN ANY PUBLIC FACING INSTALL!
## 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=
```
## So... How does it flow?
### Perform scan (run boefje)
```mermaid
sequenceDiagram
participant r as Rocky
participant c as Scheduler
participant q as RabbitMQ
participant b as Boefje
participant n as Normalizer
participant o as Octopoes
r->>+c: Start scan
c-->>r: task.status = busy
c->>q: Produce message
q->>b: Consume message
q->>n: Consume message
n->>o: Add object(s)
c->>-r: task.status = done
```
## 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/