Skip to content

Latest commit

 

History

History
213 lines (154 loc) · 9.69 KB

README.md

File metadata and controls

213 lines (154 loc) · 9.69 KB
Raw

Altinn Studio

Designer build status Repos build status

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 to get started. We've also created a introductory course for app development 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. 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

  1. Newest .NET 9 SDK
  2. Node.js (Latest LTS version, v20.*)
  3. Newest Git
  4. A code editor - we like Visual Studio Code
  5. Newest Docker Desktop
    • Requires a license in most cases. Alternative options can be found here
  6. 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.

NOTE: If you want to use Safari on MacOS add 127.0.0.1 studio.localhost to /private/etc/hosts

Running the solution locally

Clone the Altinn Studio repo and navigate to the folder.

git clone https://github.com/Altinn/altinn-studio
cd altinn-studio

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:

yarn && yarn setup

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.

  • studio-loadbalancer which is a simple nginx-container using nginx:alpine directly, just used for development.
  • studio-designer which is the actual build artifact with the .NET backend and the react-apps.
  • studio-repos which is gitea with some custom config. More here.
  • studio-db which is a postgres database used by both studio-designer and studio-repos.
  • database_migrations which is a one-time task container designed to perform and complete database migrations before exiting.
  • redis which is a redis cache used by designer.
  • redis-commander 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:

docker-compose up -d --build

The solution is now available locally at studio.localhost. (Just create a new user for testing. No email verification required). If you make changes and want to rebuild a specific project using docker-compose this can be done using

docker-compose up -d --build <container>

Example

docker-compose up -d --build studio_designer

If using the script, the .env-file is generated and put at root, otherwise you will need to place it there yourself. When starting docker-compose the solution should be running as it would in production. But you probably want to change parts of the solution. The load balancer is configured to route the traffic to the right place according to your particular use case. This is done by placing a .env-file in the same folder as compose.yaml. The load balancer is configured with the following variables.

DEVELOP_BACKEND=0
DEVELOP_DASHBOARD=0
DEVELOP_APP_DEVELOPMENT=0
DEVELOP_STUDIO_ROOT=0

Developing Backend

Navigate to the designer backend folder cd backend/src/Designer. 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 the setup script 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.

If you want to work on creating apps locally, the app-template-dotnet repo should be cloned. If the templates repo is cloned in the same folder as altinn-studio, no changes needs to be done, otherwise it should be referenced in appsettings.development.json.

{
  "GeneralSettings": {
    "TemplateLocation": "Path to src folder of app-template-dotnet repo",
    "DeploymentLocation": "Path to src/deployment folder of app-template-dotnet repo",
    "AppLocation": "Path to src/App folder of app-template-dotnet repo"
  }
}

Alternative to cloning app-templates-dotnet repo is to use following script to download template dependencies:

wget -O - https://api.github.com/repos/Altinn/app-template-dotnet/releases/latest | jq '.assets[]|select(.name | startswith("app-template-dotnet-") and endswith(".zip"))' | jq '.browser_download_url' | xargs wget -O apptemplate.zip && unzip apptemplate.zip && rm apptemplate.zip

Developing Frontend

Start the webpack dev server for the respective app you want to develop:

yarn run start-app-development
yarn run start-dashboard

If you need to rebuild other React apps, for instance dashboard or app-development, this can be done by navigating to frontend and then running the following build script, which will build app frontend apps.

yarn run build

Some React projects also have various other predefined scripts, which can be viewed in the package.json file which is located in the root folder of each react project, example frontend/dashboard.

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 are created with Playwright and run on every pull request. The usecase tests 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

Status for container scans

Designer scan Repositories scan

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the 3-Clause BSD License - see the LICENSE.md file for details.