Skip to content

Latest commit

 

History

History
153 lines (94 loc) · 6.62 KB

README.md

File metadata and controls

153 lines (94 loc) · 6.62 KB
Raw

Altinn 3

Altinn Studio is the next generation Altinn application development solution. Together with Altinn Apps and Altinn Platform (also part of this repo), this is a complete application development and hosting platform.

Altinn Studio is available at https://altinn.studio.

Read the Altinn Studio documentation to get started.

Altinn 3 concept

Build status

Apps

KubernetesWrapper build status

Studio

Designer build status Repos build status

Platform

PDF build status

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.

Getting Started

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.

Installing

Clone the Altinn Studio repo and navigate to the folder.

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

Develop Altinn Studio

To run Altinn Studio locally, follow the Altinn Studio instructions.

Develop or run Apps

First make sure to follow the prerequisites for Altinn Studio. If you need to develop or debug App-Frontend, you can follow the description in app-frontend-react repository

It's possible to run an app locally in order to test and debug it. It needs a local version of the platform services to work. NOTE: Currently, it is not possible to run Apps and Altinn Studio (designer) in parallel. To run Apps, make sure that none of the containers for Altinn Studio are running, f.ex. by navigating to the root of the altinn-studio repo, and running the command

docker-compose down
Setting up local platform services for test

  1. Navigate to the development folder in the altinn-studio repo

    cd src/development

  2. Start the loadbalancer container that routes between the local platform services and the app

    docker-compose up -d --build

  3. Set path to app folder in local platform services. There are two ways to do this:

    1. Edit the appsettings.json file:
      • Open appSettings.json in the LocalTest folder in an editor, for example in Visual Studio Code
      • Change the setting "AppRepsitoryBasePath" to the full path to your app on the disk. Save the file.
    2. Define a value using user-secrets. User secrets is a set of developer specific settings that will overwrite values from the appSettings.json file when the application is started in developer "mode". 
      dotnet user-secrets set "LocalPlatformSettings:AppRepositoryBasePath" "C:\Repos"

  4. Start the local platform services (make sure you are in the LocalTest folder)

    dotnet run

  5. Navigate to the app folder (specified in the step above), and start the app

    cd /<path to app on disk>
    dotnet run -p App.csproj

The app and local platform services are now running locally. If you have configured your hosts as described in the prerequisites, the app can be accessed on altinn3local.no.

Log in with a test user, using your app name and org name. This will redirect you to the app.

Building other react apps

If you need to rebuild other react apps, for instance Dashboard or ServiceDevelopment, this can be done by navigating to their respective folders, example src/studio/src/designer/frontend/dashboard and then run the following build script

yarn run build

Some of the react projects also have various other predefined yarn tasks, which can be viewed in the package.json file which is located in the root folder of each react project, example src/studio/stc/designer/frontend/dashboard/package.json

Running the tests

End to end tests

Integration tests for local studio.

Frontend lint and unit tests

See readme in studio and Altinn.Apps AppFrontend projects for details on how to run these tests.

Deployment

The current build is deployed in Kubernetes on Azure.

Automated build/deploy process is being developed.

Built With

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.