https://github.com/altinn/altinn-events
Altinn platform microservice for handling events
https://github.com/altinn/altinn-events
Last synced: 9 months ago
JSON representation
Altinn platform microservice for handling events
- Host: GitHub
- URL: https://github.com/altinn/altinn-events
- Owner: Altinn
- License: mit
- Created: 2022-02-21T21:08:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-22T13:27:33.000Z (10 months ago)
- Last Synced: 2025-08-22T14:24:27.770Z (10 months ago)
- Language: C#
- Size: 1.46 MB
- Stars: 2
- Watchers: 20
- Forks: 1
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Altinn Events
Create and subscribe to events from apps or other sources.
Documentation: https://docs.altinn.studio/events
## Build status
[](https://dev.azure.com/brreg/altinn-studio/_build/latest?definitionId=136)
## Getting Started
These instructions will get you a copy of the events component up and running on your machine for development and testing purposes.
### Prerequisites
1. [.NET 9.0 SDK](https://dotnet.microsoft.com/download/dotnet/9.0)
2. Newest [Git](https://git-scm.com/downloads)
3. A code editor - we like [Visual Studio Code](https://code.visualstudio.com/download)
- Install [Azure Functions extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurefunctions). You can also install the [Azure Tools extension pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-node-azure-pack), which is recommended for working with Azure resources.
- Also install [recommended extensions](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions) (e.g. [C#](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp))
4. [Podman](https://podman.io/) or another container tool such as Docker Desktop
5. [PostgreSQL](https://www.postgresql.org/download/)
6. [pgAdmin](https://www.pgadmin.org/download/)
7. Install [Azurite](https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=visual-studio%2Cblob-storage#install-azurite)
8. Install [Azure Functions Core Tool](https://learn.microsoft.com/en-us/azure/azure-functions/functions-run-local?tabs=windows%2Cisolated-process%2Cnode-v4%2Cpython-v2%2Chttp-trigger%2Ccontainer-apps&pivots=programming-language-powershell#install-the-azure-functions-core-tools)
### Setting up PostgreSQL
Ensure that both PostgreSQL and pgAdmin have been installed and start pgAdmin.
In pgAdmin
- Create database _eventsdb_
- Create the following users with password: _Password_ (see privileges in parentheses)
- platform_events_admin (superuser, canlogin)
- platform_events (canlogin)
- Create schema _events_ in eventsdb with owner _platform_events_admin_
A more detailed description of the database setup is available in [our developer handbook](https://docs.altinn.studio/community/contributing/handbook/postgres/)
### Cloning the application
Clone [Altinn Events repo](https://github.com/Altinn/altinn-events) and navigate to the folder.
```bash
git clone https://github.com/Altinn/altinn-events
cd altinn-events
```
### Running the application in a docker container
- [Start Azurite](https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=visual-studio%2Cblob-storage#run-azurite)
- Start Altinn Events docker container run the command
```cmd
podman compose up -d --build
```
- To stop the container running Altinn Events run the command
```cmd
podman stop altinn-events
```
The events solution is now available locally at http://localhost:5080/.
To access swagger use http://localhost:5080/swagger.
### Running the application with .NET
The Events components can be run locally when developing/debugging. Follow the install steps above if this has not already been done.
- [Start Azurite](https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=visual-studio%2Cblob-storage#run-azurite)
- Navigate to _src/Events_, and build and run the code from there, or run the solution using you selected code editor
```cmd
cd src/Events
dotnet run
```
The events solution is now available locally at http://localhost:5080/.
To access swagger use http://localhost:5080/swagger.
### Running functions
- [Start Azurite](https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=visual-studio%2Cblob-storage#run-azurite)
Start Altinn Events Functions
```bash
cd src/Events.Functions
func start
```
#### Integration tests that require Azurite
Some integration tests require Azurite to run. They are tagged with a custom attribute and will be skipped unless the environment variable `ENABLE_AZURITE_TESTS` is set to `1` or `true`.
To run them locally:
1. Start Azurite.
2. Set `ENABLE_AZURITE_TESTS`.
3. Run the tests from your Test Explorer or via CLI:
Windows (PowerShell):
```powershell
$env:ENABLE_AZURITE_TESTS = "1"
dotnet test test/Altinn.Platform.Events.Functions.Tests
```
macOS/Linux (bash/zsh):
```bash
export ENABLE_AZURITE_TESTS=1
dotnet test test/Altinn.Platform.Events.Functions.Tests
```