ARA - Energiatodistuspalvelu

Tämä on web sovellus energiatodistusten laadintaan ja todistuksiin liittyvään viranomaistoimintaan.

This is a web application for managing energy performance certificates and related activities. This application is for accredited certificate experts and public authorities.

Node.js has to be installed and preferred node version manager tool is node version manager.

Node version manager

https://github.com/nvm-sh/nvm#git-install

source ~/.nvm/nvm.sh
nvm use

Get started

Install the dependencies...

npm install

You also need to start backend services found in different repository.

...then start webpack

npm run dev

Navigate to https://localhost:3000. You should see your app running. Edit a component file in src, save it, the page should reload automatically.

Testing

Mocha

Run unit tests with:

npm run test

or

npm run tdd

The latter command watches file changes and reruns tests upon saved changes.

Cypress

Make sure you installed optional dependencies from npm. Then just use the command:

npm run cypress

Building and running in production mode

To create a production optimised version of the app:

npm run build

About the application

Directory structure

./src

Contains all the application code divided into subfolders for different purposes. The root contains internal riggin required for scaffolding the application.

./src/components

General components to be used in UI building e.g. inputs, buttons etc. These components can be used in any page.

./src/pages

All pages and their components. Pages are grouped by feature-basis. Each feature contains:

• index (index.svelte)
• page components and specialized components used from these pages (*.svelte)
• api modules (*-api.js) to create backend futures
• datamodel validation schemas (schema.js)
• other functional utility modules (*.js)

Specialized components (used only from a specific place) are:

• header
• breadcrumb
• navigation
• footer
• valvonta (used from valvonta-oikeellisuus/valvonta-kaytto)

./src/language

Translations, i18n riggings and some utilities for handling objects with fi/sv-label fields.

./src/utils

General purpose pure function libraries.

./assets

Static assets (images, pdfs, etc.)

./cypress

Cypress tests

Best practices

Naming things

• Directories/files should be kebab-case
• Imported namespaces should be pascal-case
• Data models used with backend are kebab-case
• Otherwise use camel-case.

Monadic types

Always use proper monadic type for special cases.

• Instead of null, use Maybe.
• Everything that could fail (f.ex. parsing/validation) synchronously should be wrapped in Either where Left is error and Right is value.
• Asynchronous operations should be wrapped in futures.

Programming style

• In general prefer functional programming style.
• Variable reassignment should only happen with svelte components. Always declare variables with const.
• No mutations allowed
• Heavy utilization of Ramda
• Curry-functions and compositions
• Write pointfree/tacit code
• Only pure functions in utilities, side effects allowed inside svelte components
• Try to achieve good test coverage with unit tests.
• If you find 2 different ways to achieve the same result within codebase; default to the newer version for examples when writing new code.