Altinn / altinn-studio

Altinn Studio Altinn Studio is the next generation Altinn application development solution. Together with **Altinn Apps** and **Altinn Platform**, this is a complete application development and hosting platform (Altinn 3). Read the [Altinn Studio documentation][1] to [get started][2]. We've also created an [introductory course for app development][3] that you can follow at your own pace. > **Note** Developing apps? > If you just want to quickly perform tests of your app on your development machine you can follow the instructions on > how to [run apps locally][4]. This repository is mainly the Designer-tool which is used to build and > deploy apps. Getting Started with developing Altinn Studio These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. Prerequisites • Newest [.NET 9 SDK][5] • [Node.js][6] (Latest LTS version) • Newest [Git][7] • A code editor - we like [Visual Studio Code][8] • Also install [recommended extensions][9] (e.g. [C# Dev Kit][10]) • Newest [Docker Desktop][11] • Requires a license in most cases. Alternative options can be found [here][12] • If you are running Docker Desktop in Hyper-V mode you need to make sure your C drive is shared with Docker, Docker Settings -> Shared Drives The File sharing tab is only available in Hyper-V mode, because in WSL 2 mode and Windows container mode all files are automatically shared by Windows. Hosts file Add the following entries to your hosts file ( on Linux/MacOS, on Windows): Running the solution locally Clone the [Altinn Studio repo][13] and navigate to the folder. The fastest way to get things running from scratch is to use our setup-script. This script will start docker and ensure that the setup is up to date. As we add more features this script will be updated. It can be run as follows: More about that script and development in general, can be found here. Docker Compose The development environment consist of several services defined in compose.yaml. • which is a simple nginx-container using directly, just used for development. • which is the actual build artifact with the .NET backend and the react-apps. • which is [gitea][14] with some custom config. More here. • which is a postgres database used by both and . • which is a one-time task container designed to perform and complete database migrations before exiting. • which is a administration and development platform for PostgreSQL. • which is a redis cache used by designer. • which is a ui for redis cache. Run all parts of the solution in containers (Make sure docker is running), with docker compose as follows: The solution is now available locally at [studio.localhost][15]. When logging in, use the default username . You can find the randomly generated password in the file, under the variable. If you make changes and want to rebuild a specific project using docker compose, this can be done from using Example If using , the -file is generated and put at root. Otherwise, you will need to place it there yourself. Development variables When starting the solution should be running as it would in production. But you probably want to develop parts of the solution without rebuilding containers. The load balancer is configured to route traffic to your local dev servers instead of the Docker containers when the corresponding variable is set to . This is done by editing the -file in the same folder as compose.yaml. After changing these variables, rebuild the load balancer from : The available variables are: Developing Backend Navigate to the designer backend folder . The first time running, or after any package changes, get the latest packages. The backend uses the OIDC login flow with Gitea as the identity provider. The client ID and client secret are required in the configuration. When running the backend locally, the .env file will be used to fetch the client ID and secret if they are not already set in the configuration. If is run, an OAuth2 application will be created in Gitea, and the CLIENT_ID and CLIENT_SECRET values will be set in the .env file. Alternatively, you can set up the OAuth2 application yourself in Gitea and manually set the client ID and client secret values in the configuration. Developing Frontend Start the vite dev server for the respective app you want to develop: If you need to rebuild other React apps, for instance or , this can be done by navigating to and then running the following build script, which will build app frontend apps. Some React projects also have various other predefined scripts, which can be viewed in the file which is located in the root folder of each react project, example . More about developing frontend can be found here. End-to-end tests Altinn Studio has two sets of automated end-to-end tests; regression tests and usecase tests. [The regression tests][16] are created with Playwright and run on every pull request. [The usecase tests][17] are created with Cypress and run periodically. For more information about testing, please refer to the following resources: Playwright and Cypress. Deployment The current build is deployed in Kubernetes on Azure. Automated CI/CD using Azure DevOps pipelines. Built With • [React][18] - The front-end framework • [.NET Core][19]/[C#][20] - The back-end framework • [yarn][21] - Package management • [Docker][22] - Container platform • [Kubernetes][23] - Container orchestration Status for container scans Contributing Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us. • Wiki: Altinn/altinn-studio/wiki • ADRs: /docs/adr/ • Diagrams: /docs/diagrams/ Authors • **Altinn Studio development team** - If you want to get in touch, just [create a new issue][24]. See also the [list of contributors][25] who participated in this project. License This project is lice…