Getting Started
Last updated
Was this helpful?
Last updated
Was this helpful?
This is the center of development for digital government services on island.is
. It is managed by the department inside the .
These solutions are and open to contributions, but most development will be performed by teams that win tenders to develop new functionality for Digital Iceland.
The repository is a that has multiple apps (something that can be built and run) and libraries (which other apps and libraries can depend on). All custom-written services are also stored there.
The apps and libraries documentation and our handbook are hosted on and is publicly available at .
The Ísland.is design system is developed and showcased using and is publicly available at .
To get more technical information about the project please make sure to read this .
If you want to contribute to the repository, please make sure to follow .
brew install awscli
brew install jq
There are many projects that can be built and run.
To list projects that can be built the following command can be used
Run on whenever you check out a branch:
When you clone the repo for the first time, and whenever you change branches, you need to update your dependencies to match your current branch using yarn install
. In addition, schemas change frequently, so you will also need to update the generated schemas and clients using yarn codegen
.
For a dev server:
The app will automatically reload if you change any of the source files.
To build the project:
The build artifacts will be stored in the dist/
directory. Use the --prod
flag for a production build.
You need to format all files to follow Nx code conventions. To do so run:
We have many lint rules to help having a unify code all over the project. To execute the linting:
Running lint locally is slow and fill up heap memory. This is related to Typescript compilation and Nx lint builder being slow. As a result you might get a
JavaScript heap out of memory
. Nx is working on fixing this for an upcoming update. In the meantime you can doNODE_OPTIONS=“--max-old-space-size=4096” yarn lint <project>
to raise the memory limit.
To execute the unit tests affected by a change:
To see a diagram of the dependencies of your projects:
If you have AWS access to our development account, you can connect to development databases and services using a proxy. We've set up a proxy and connection helpers for our development Postgres, Elastic Search, Redis and X-Road Security Server.
To do so, you can run for example:
The following services will run on the associated ports: db:5432
, es:9200
, redis:6379
, xroad:80
. If you have docker running on theses ports or any others services you will need to stop them in order to run the proxies.
To be able to access environment variables in purely static projects, you need to do the following:
In the index.html file, add <!-- environment placeholder -->
.
Use the getStaticEnv
function from the @island.is/shared/utils
library to fetch your environment variables.
Prefix your environment variables with SI_PUBLIC_
, for example SI_PUBLIC_MY_VARIABLE
.
NOTE: This is only to get environment variables when running in kubernetes, not for when running locally. So you should only use getStaticEnv
in your environment.prod.ts
file.
What happens behind the scenes is that static projects have a bash script that runs when the docker container starts up. This script searches for references of SI_PUBLIC_*
in the code and tries to find a match in the environment. It then puts all the matches inside the index.html which is then served to the client.
You have Node and Yarn installed as outlined in the engines
section in the repository's
You have installed.
You have installed.
You have >= 1.8
installed (for schema generation).
If you are running on Windows we recommend using
You have installed.
You have installed.
See further useage of the Nx show command in their .
To execute the unit tests via :
See our technical documentation on our .
If your project is generating schemas files from an OpenAPI, Codegen or is an API, check out .
A dedicated documentation about fetching shared development secrets or creating new secrets, using AWS secrets is available .
It will try to get your AWS credentials from your environment variables and from your ~/.aws/credentials
file. You can find more instructions .