Palaute

More commonly known as Norppa

The open source course feedback system used by University of Helsinki and Tampere University

Production in https://norppa.helsinki.fi

Found a bug or have a feature request?

Write an issue if you find mistakes, problems or something to improve in Palaute. Feel free to create a pull request.

Contributing

Environment configuration

Create a .env file inside the project's root directory. In that file, copy the contents of the .env.template file and add correct values for the variables based on the documentation.

How users can get started with Palaute

Clone the repo, install docker to get started!

Before starting the project for the first time run npm i to install needed development dependencies.

To start the project in development mode use this command. It will start everything in development mode:

$ npm run start

To populate the Norppa and Jami databases from a backup in remote server, use

./scripts/get_prod_db.sh

If you are not in Toska, you can still use the script for reference.

Stuck?

If stuck reset everything and start from a clean slate:

$ npm run reset

Commit guidelines

We like the Conventional Commits specification.

To automatically create commits that adhere to the spec, use CommitSense.

Documentation

Service architecture overview

The Norppa core in this repo consists of a NodeJS server and a React frontend, but the entire Norppa system is built of many more services. The following graph describes Norppa service implementation in UoH.

graph TB
    subgraph Norppa
        subgraph Norppa core
            direction TB
            client[React app] --> server[NodeJS server]
        end

        server -->|Read, Write| pg[(Postgres)]
        updater[Updater] -->|Write| pg
    end

    subgraph Common Toska services
        jami[JAMI]
        pate[Pate]
        importer[Importer]
    end

    updater -->|Fetch data| importer
    importer -->|Fetch data| sisu[Sisu export APIs]
    server -->|Get IAM access| jami
    server -->|Send mail| pate


    subgraph Analytics
        direction TB
        sentry[Sentry]
        graylog[Graylog]
        grafana[Grafana]
    end

When implementing Norppa for your organisation, you will implement your own updater, jami, pate and possibly some kind of importer, as well as analytics.

Topics

Documentation guidelines

Document whatever cannot be documented in code or needs visibility for a broader audience.
The biggest and only crime is to not delete or update outdated documentation when you notice it. No need to ask for permission to do so.

Documentation Feedback

Need something documented or see a problem in existing docs? Please give feedback in the form of issues (add the documentation tag). All kinds of feedback is welcome from everyone reading the Norppa documentation.