Search…
Application System

About

This project forms the base for all business applications belonging to island.is.

Quickstart

Ensure docker is running, then run the following to set up:
yarn nx run application-system-api:dev/init
This command runs all initial setup in the sections API and Form below.
Then whenever you want to work on the application-system run this command:
yarn nx run application-system-api:dev
This command runs all running locally in the sections API, Form and graphql below, as well as starting x-road and soffia proxies.

URLs

API

Initial setup

First, make sure you have docker, then run:
yarn dev-services application-system-api
Then run the migrations:
yarn nx run application-system-api:migrate

Running locally

You can serve this service locally by running:
yarn start application-system-api

Graphql

Make sure you are serving the graphql client as well in order for you to make graphql calls to this service:
yarn start api

OpenApi and Swagger

When making changes to the module code, run
yarn nx schemas/build-openapi application-system-api
to generate the code needed for openapi and swagger. Then you can visit
localhost:3333/swagger
In order to generate a typed fetch client run
yarn nx schemas/openapi-generator api-domains-application
In order to update the graphql schema as well, run
yarn nx schemas/build-graphql-schema api

Form

This app contains the frontend app for the application system

Running locally

You can serve this app locally by running:
yarn start application-system-form
The only backend apps this app depends on are the graphql api and the application-system-api. Therefore, make sure you run those as well:
yarn start application-system-api
(see apps/application-system/api/README.md if you run into any problems here)
and
yarn start api

Adding a new template

After following the Reference Template, repeat the steps from OpenAPI and Swagger or run yarn install to update schemas.

Adding a payment step

If your application requires that the user pay a fee as part of the application process, that can be implemented by following the adding a payment step guide

Testing

It is as simple as:
yarn nx test application-system-form

Code owners and maintainers

Copy link
On this page
About
Quickstart
URLs
API
Initial setup
Running locally
Graphql
OpenApi and Swagger
Form
Running locally
Adding a new template
Adding a payment step
Testing
Code owners and maintainers