This repository is the center of development for digital government
services on island.is. It is managed by the Digital Iceland department
inside the Ministry of Finance and Economic Affairs.
These solutions are FOSS and open to contributions, but most development is performed by teams that win tenders to develop new functionality for Digital Iceland.
We are working on documentation and workflows to help external developers understand and run these solutions locally.
For now, we appreciate assistance with security reviews (more eyes = better), documentation and smaller fixes.
A good place to start is the Development Handbook.
You can also read up on our development stack and preferred tools:
| Tool | Description |
|---|---|
| NodeJS | scripts and server-side framework |
| TypeScript | programming language |
| NX | monorepo tools and code scaffolding |
| Tool | Description |
|---|---|
| React | UI framework |
| NextJS | front-end framework with routing and server side rendering |
| Treat | css-in-js |
| Storybook | develop and document React components in isolation |
| Apollo Client | graphql client |
| GraphQL Code Generator | generate GraphQL clients and types |
| Cypress | automated browser testing tool |
| MirageJS | API mocking for webapps |
| Tool | Description |
|---|---|
| NestJS | server-side framework for NodeJS |
| Sequelize | database object relational mapper |
| OpenAPI Generator | generate clients and types for OpenAPI APIs |
| Tool | Description |
|---|---|
| Jest | automated testing tool |
| ESLint | code checker |
| Prettier | code formatter |
| Tool | Description |
|---|---|
| GraphQL | api protocol for our frontend projects |
| OpenAPI | specification to describe rest apis |
| Open ID Connect | authentication protocols |
| Tool | Description |
|---|---|
| PostgreSQL | SQL database |
| Contentful | headless content management system |
| Tool | Description |
|---|---|
| Docker | virtual machine containers for continuous integration and deployment |
| Kubernetes | host docker containers in production |
| Helm | kubernetes deployment configuration |
The repository is a monorepo that has multiple apps (something that can be built and run) and libraries (which other apps and libraries can depend on).
Our system architecture generally includes frontend projects, a graphql API gateway, and service APIs. Many of these projects are in early development.
Featured projects:
Other projects:
Run yarn start <project> for a dev server. The app will automatically reload if you change any of the source files.
Run yarn build <project> to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.
Run yarn test <project> to execute the unit tests via Jest.
Run yarn affected:test to execute the unit tests affected by a change.
Run yarn e2e <project>-e2e to execute end-to-end tests via Cypress.
Run yarn affected:e2e to execute the end-to-end tests affected by a change.
Run yarn generate @nrwl/react:component MyComponent --project=island-ui-core to generate a new component in island-ui-core.
Run yarn generate @nrwl/react:app my-app to generate a simple React application.
To get a React application with server-side-rendering, we recommend using Next.JS: yarn generate @nrwl/next:app my-app
To create a service, you can get started with NestJS like this: yarn generate @nrwl/nest:app services/my-service
Run yarn generate @nrwl/react:lib my-lib --linter eslint to generate a React library.
To create a NestJS module: yarn generate @nrwl/node:lib my-lib
To create a JS library that can be used both on the frontend and the backend: yarn generate @nrwl/node:lib my-lib
Libraries are sharable across libraries and applications. They can be imported from @island.is/my-lib.
Applications and libraries can be structured in a hierarchy using subfolders:
yarn generate @nrwl/node:lib common/my-lib
# Imported from '@island.is/common/my-lib'
Using the sequelize-cli we support version controlled migrations that keep track of changes to the database.
Run yarn nx run <project>:migrate/generate
Run yarn nx run <project>:migrate
All api calls should be type checked to backend schemas. When you update an API, you may need to generate schema files:
yarn nx run <project>:generate-schema
And generate client types that depend on the schema:
yarn nx run <project>:codegen
Run yarn nx dep-graph to see a diagram of the dependencies of your projects.
Run yarn env-secrets <project> [options]
Example:
yarn env-secrets gjafakort --reset
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent