Handbook
Development handbook for Altinn Studio
WARNING: The development handbook is currently being written, and is as such not complete or final.
The development handbook should provide all basic information needed to get started with development on Altinn Studio. It should alto contain the information needed to make sure all developers write their code in a consistent way. The development handbook should work as reference material, but it should also be possible to read throught the whole handbook in a logical order so that new developers quickly get up and running.
The development handbook is a dynamic material and everybody should feel free to extend or correct articles when needed.
-
Azure Dev Spaces
Guidelines for deploying storage
-
Azure DevOps
Guidelines for working with resources in Azure DevOps
-
Pipelines
Quality checklist and overview of pipelines in Azure DevOps
-
Back-end
Coding guidelines for back-end
-
Async programming
Guidelines for asynchronous programming
-
Error handling and Error logging
Guidelines for error handling and error logging in backend
-
Nuget Package
Overview of nuget package usage in altinn studio
-
Cheat Sheet
Qucik guide for different commands
-
Deployment
Guidelines for deploying
-
Front-end
Coding guidelines for front-end
-
Getting started
Get started working with the frontend
-
Developing
Running the frontends locally for development
-
React
Guidelines for using React in Altinn Studio
-
Redux
Guidelines for using Redux in Altinn Studio
-
Debug
Debug documentation for altinn.studio frontend
-
Best practices
Best practices for altinn.studio frontend
-
Build
Build documentation for altinn.studio frontend
-
Component Library
Component documentation for altinn.studio
-
Error handling
Guidelines for error handling front-end
-
Post Message
Guidelines for using post message functionality in Altinn Studio
-
Styling (css)
Guidelines for styling components in Altinn Studio
-
Versioning
Guidelines for versioning of front-end
-
General
General coding guidelines
-
Getting started
Information about how to get started
-
Git
Information about version control with Git
-
Gitea
Gitea documentation for altinn.studio
-
Naming Conventions
Naming guidelines for Altinn Studio development
-
Nginx loadbalancing in studio
Information about routing with nginx
-
Nginx SSL/TLS certificate
Information about SSL/TLS certificates with nginx
-
RESTful APIs (Representation State Transfer)
Guidelines for designing REST apis for microservices in Altinn
-
Routing
Information about routing
-
Nginx routing
Information about routing with nginx
- Traefik routing
-
Installation of Traefik 2.0
How to install traefik
-
TLS in Traefik 2.0
How to set up TLS
-
Traefik custom resources
Definitions for traefik 2.0 custom resources in kubernetes
-
Traefik ingress routes
How to set up an ingress route and route trafic based on rules and middlewares
-
Security Checklist
Checklist for security OWASP.
-
Test
Coding guidelines for tests
-
Automated test app
An app used solely for automated testing in the browser
-
Postman
API Testing with postman
-
Test Coverage
Automation testcases by area
-
Test Strategy
Test Strategy
-
Testcafe
Testcafe
-
Testcafe - Tests
How to write and maintain testcafe tests
-
Unit testing
How to write jest test in altinn studio, what we know so far
-
WCAG testing in Altinn Studio
Coding guidelines for tests
-
Xunit Testing
Xunit Testing
-
k6
Performance and Functional Testing of API with K6
-
Troubleshooting
Troubleshooting for altinn.studio
-
Theming and styling
Solution for theming and styling conventions.
-
Reusable resources
A important feature with Altinn Studio is that it should promote developers to create reusable resources that can be reused by other developers.