FossaApp API

The FossaApp API provides backend services for a business management application. It handles entities such as Companies, Employees, and Branches, and includes features for authentication, authorization, and software licensing.

Getting Started

The easiest way to run the API is by using Docker.

Prerequisites

Docker

Running with Docker

Create a .env file with the required configuration variables (see the Configuration section below).
Run the Docker container:
```
docker run --rm -it -p 8080:8080 --env-file .env tiksn/fossa-api:latest
```
This image supports multiple architectures (linux/amd64, linux/arm64).

Configuration

The API is configured using environment variables. The following table lists the available variables:

Variable	Description	Default Value
`ConnectionStrings__MongoDB`	The connection string for the MongoDB database.	(none)
`Identity__RootAddress`	The root URL of the identity provider (e.g., FusionAuth).	`http://localhost:9011/`
`Identity__Audience`	The audience for the JWT tokens.	(none)
`Identity__ApiKey`	The API key for communicating with the identity provider.	(none)
`Paging__MaximumPageSize`	The maximum number of items that can be requested in a single page.	`100`
`GeneratorId`	The ID of the instance for distributed ID generation. Should be unique for each running instance of the API.	`0`
`ASPNETCORE_ENVIRONMENT`	The runtime environment. Set to `Development` for development-specific features.	`Production`
`ASPNETCORE_URLS`	The URLs the web host will listen on.	`http://+:8080`

API Documentation

The API includes built-in documentation, which is available when the application is running.

Swagger UI: http://localhost:8080/swagger
Scalar: http://localhost:8080/scalar

Health Checks

The application provides a health check endpoint to monitor its status.

Endpoint: http://localhost:8080/healthchecks

Building from Source

Prerequisites

.NET 10 SDK
Docker, for Testcontainers-backed integration tests
An identity provider like FusionAuth running.

Instructions

Set up User Secrets: The application requires secrets for the database connection string and identity configuration.

dotnet user-secrets set"ConnectionStrings:MongoDB""your-mongodb-connection-string"
dotnet user-secrets set"Identity:Audience""your-jwt-audience"
dotnet user-secrets set"Identity:ApiKey""your-fusionauth-api-key"

Restore dependencies and run the application:

dotnet restore
dotnet run --project src/API.Web

The API will be available at http://localhost:5000 (or as configured in launchSettings.json).

Testing

Integration tests use Testcontainers and require a running Docker daemon. Run the integration suite with:

dotnet test tests/API.IntegrationTests/API.IntegrationTests.csproj

FossaApp API

The FossaApp API provides backend services for a business management application. It handles entities such as Companies, Employees, and Branches, and includes features for authentication, authorization, and software licensing.

Getting Started

The easiest way to run the API is by using Docker.

Prerequisites

Docker

Running with Docker

Create a .env file with the required configuration variables (see the Configuration section below).
Run the Docker container:
```
docker run --rm -it -p 8080:8080 --env-file .env tiksn/fossa-api:latest
```
This image supports multiple architectures (linux/amd64, linux/arm64).

Configuration

The API is configured using environment variables. The following table lists the available variables:

Variable	Description	Default Value
`ConnectionStrings__MongoDB`	The connection string for the MongoDB database.	(none)
`Identity__RootAddress`	The root URL of the identity provider (e.g., FusionAuth).	`http://localhost:9011/`
`Identity__Audience`	The audience for the JWT tokens.	(none)
`Identity__ApiKey`	The API key for communicating with the identity provider.	(none)
`Paging__MaximumPageSize`	The maximum number of items that can be requested in a single page.	`100`
`GeneratorId`	The ID of the instance for distributed ID generation. Should be unique for each running instance of the API.	`0`
`ASPNETCORE_ENVIRONMENT`	The runtime environment. Set to `Development` for development-specific features.	`Production`
`ASPNETCORE_URLS`	The URLs the web host will listen on.	`http://+:8080`

API Documentation

The API includes built-in documentation, which is available when the application is running.

Swagger UI: http://localhost:8080/swagger
Scalar: http://localhost:8080/scalar

Health Checks

The application provides a health check endpoint to monitor its status.

Endpoint: http://localhost:8080/healthchecks

Building from Source

Prerequisites

.NET 10 SDK
Docker, for Testcontainers-backed integration tests
An identity provider like FusionAuth running.

Instructions

Set up User Secrets: The application requires secrets for the database connection string and identity configuration.

dotnet user-secrets set"ConnectionStrings:MongoDB""your-mongodb-connection-string"
dotnet user-secrets set"Identity:Audience""your-jwt-audience"
dotnet user-secrets set"Identity:ApiKey""your-fusionauth-api-key"

Restore dependencies and run the application:

dotnet restore
dotnet run --project src/API.Web

The API will be available at http://localhost:5000 (or as configured in launchSettings.json).

Testing

Integration tests use Testcontainers and require a running Docker daemon. Run the integration suite with:

dotnet test tests/API.IntegrationTests/API.IntegrationTests.csproj

FossaApp API

The FossaApp API provides backend services for a business management application. It handles entities such as Companies, Employees, and Branches, and includes features for authentication, authorization, and software licensing.

Getting Started

The easiest way to run the API is by using Docker.

Prerequisites

Docker

Running with Docker

Create a .env file with the required configuration variables (see the Configuration section below).
Run the Docker container:
```
docker run --rm -it -p 8080:8080 --env-file .env tiksn/fossa-api:latest
```
This image supports multiple architectures (linux/amd64, linux/arm64).

Configuration

The API is configured using environment variables. The following table lists the available variables:

Variable	Description	Default Value
`ConnectionStrings__MongoDB`	The connection string for the MongoDB database.	(none)
`Identity__RootAddress`	The root URL of the identity provider (e.g., FusionAuth).	`http://localhost:9011/`
`Identity__Audience`	The audience for the JWT tokens.	(none)
`Identity__ApiKey`	The API key for communicating with the identity provider.	(none)
`Paging__MaximumPageSize`	The maximum number of items that can be requested in a single page.	`100`
`GeneratorId`	The ID of the instance for distributed ID generation. Should be unique for each running instance of the API.	`0`
`ASPNETCORE_ENVIRONMENT`	The runtime environment. Set to `Development` for development-specific features.	`Production`
`ASPNETCORE_URLS`	The URLs the web host will listen on.	`http://+:8080`

API Documentation

The API includes built-in documentation, which is available when the application is running.

Swagger UI: http://localhost:8080/swagger
Scalar: http://localhost:8080/scalar

Health Checks

The application provides a health check endpoint to monitor its status.

Endpoint: http://localhost:8080/healthchecks

Building from Source

Prerequisites

.NET 10 SDK
Docker, for Testcontainers-backed integration tests
An identity provider like FusionAuth running.

Instructions

Set up User Secrets: The application requires secrets for the database connection string and identity configuration.

dotnet user-secrets set"ConnectionStrings:MongoDB""your-mongodb-connection-string"
dotnet user-secrets set"Identity:Audience""your-jwt-audience"
dotnet user-secrets set"Identity:ApiKey""your-fusionauth-api-key"

Restore dependencies and run the application:

dotnet restore
dotnet run --project src/API.Web

The API will be available at http://localhost:5000 (or as configured in launchSettings.json).

Testing

Integration tests use Testcontainers and require a running Docker daemon. Run the integration suite with:

dotnet test tests/API.IntegrationTests/API.IntegrationTests.csproj

FossaApp API

The FossaApp API provides backend services for a business management application. It handles entities such as Companies, Employees, and Branches, and includes features for authentication, authorization, and software licensing.

Getting Started

The easiest way to run the API is by using Docker.

Prerequisites

Docker

Running with Docker

Create a .env file with the required configuration variables (see the Configuration section below).
Run the Docker container:
```
docker run --rm -it -p 8080:8080 --env-file .env tiksn/fossa-api:latest
```
This image supports multiple architectures (linux/amd64, linux/arm64).

Configuration

The API is configured using environment variables. The following table lists the available variables:

Variable	Description	Default Value
`ConnectionStrings__MongoDB`	The connection string for the MongoDB database.	(none)
`Identity__RootAddress`	The root URL of the identity provider (e.g., FusionAuth).	`http://localhost:9011/`
`Identity__Audience`	The audience for the JWT tokens.	(none)
`Identity__ApiKey`	The API key for communicating with the identity provider.	(none)
`Paging__MaximumPageSize`	The maximum number of items that can be requested in a single page.	`100`
`GeneratorId`	The ID of the instance for distributed ID generation. Should be unique for each running instance of the API.	`0`
`ASPNETCORE_ENVIRONMENT`	The runtime environment. Set to `Development` for development-specific features.	`Production`
`ASPNETCORE_URLS`	The URLs the web host will listen on.	`http://+:8080`

API Documentation

The API includes built-in documentation, which is available when the application is running.

Swagger UI: http://localhost:8080/swagger
Scalar: http://localhost:8080/scalar

Health Checks

The application provides a health check endpoint to monitor its status.

Endpoint: http://localhost:8080/healthchecks

Building from Source

Prerequisites

.NET 10 SDK
Docker, for Testcontainers-backed integration tests
An identity provider like FusionAuth running.

Instructions

Set up User Secrets: The application requires secrets for the database connection string and identity configuration.

dotnet user-secrets set"ConnectionStrings:MongoDB""your-mongodb-connection-string"
dotnet user-secrets set"Identity:Audience""your-jwt-audience"
dotnet user-secrets set"Identity:ApiKey""your-fusionauth-api-key"

Restore dependencies and run the application:

dotnet restore
dotnet run --project src/API.Web

The API will be available at http://localhost:5000 (or as configured in launchSettings.json).

Testing

Integration tests use Testcontainers and require a running Docker daemon. Run the integration suite with:

dotnet test tests/API.IntegrationTests/API.IntegrationTests.csproj

FossaApp API

The FossaApp API provides backend services for a business management application. It handles entities such as Companies, Employees, and Branches, and includes features for authentication, authorization, and software licensing.

Getting Started

The easiest way to run the API is by using Docker.

Prerequisites

Docker

Running with Docker

Create a .env file with the required configuration variables (see the Configuration section below).
Run the Docker container:
```
docker run --rm -it -p 8080:8080 --env-file .env tiksn/fossa-api:latest
```
This image supports multiple architectures (linux/amd64, linux/arm64).

Configuration

The API is configured using environment variables. The following table lists the available variables:

Variable	Description	Default Value
`ConnectionStrings__MongoDB`	The connection string for the MongoDB database.	(none)
`Identity__RootAddress`	The root URL of the identity provider (e.g., FusionAuth).	`http://localhost:9011/`
`Identity__Audience`	The audience for the JWT tokens.	(none)
`Identity__ApiKey`	The API key for communicating with the identity provider.	(none)
`Paging__MaximumPageSize`	The maximum number of items that can be requested in a single page.	`100`
`GeneratorId`	The ID of the instance for distributed ID generation. Should be unique for each running instance of the API.	`0`
`ASPNETCORE_ENVIRONMENT`	The runtime environment. Set to `Development` for development-specific features.	`Production`
`ASPNETCORE_URLS`	The URLs the web host will listen on.	`http://+:8080`

API Documentation

The API includes built-in documentation, which is available when the application is running.

Swagger UI: http://localhost:8080/swagger
Scalar: http://localhost:8080/scalar

Health Checks

The application provides a health check endpoint to monitor its status.

Endpoint: http://localhost:8080/healthchecks

Building from Source

Prerequisites

.NET 10 SDK
Docker, for Testcontainers-backed integration tests
An identity provider like FusionAuth running.

Instructions

Set up User Secrets: The application requires secrets for the database connection string and identity configuration.

dotnet user-secrets set"ConnectionStrings:MongoDB""your-mongodb-connection-string"
dotnet user-secrets set"Identity:Audience""your-jwt-audience"
dotnet user-secrets set"Identity:ApiKey""your-fusionauth-api-key"

Restore dependencies and run the application:

dotnet restore
dotnet run --project src/API.Web

The API will be available at http://localhost:5000 (or as configured in launchSettings.json).

Testing

Integration tests use Testcontainers and require a running Docker daemon. Run the integration suite with:

dotnet test tests/API.IntegrationTests/API.IntegrationTests.csproj

FossaApp API

The FossaApp API provides backend services for a business management application. It handles entities such as Companies, Employees, and Branches, and includes features for authentication, authorization, and software licensing.

Getting Started

The easiest way to run the API is by using Docker.

Prerequisites

Docker

Running with Docker

Create a .env file with the required configuration variables (see the Configuration section below).
Run the Docker container:
```
docker run --rm -it -p 8080:8080 --env-file .env tiksn/fossa-api:latest
```
This image supports multiple architectures (linux/amd64, linux/arm64).

Configuration

The API is configured using environment variables. The following table lists the available variables:

Variable	Description	Default Value
`ConnectionStrings__MongoDB`	The connection string for the MongoDB database.	(none)
`Identity__RootAddress`	The root URL of the identity provider (e.g., FusionAuth).	`http://localhost:9011/`
`Identity__Audience`	The audience for the JWT tokens.	(none)
`Identity__ApiKey`	The API key for communicating with the identity provider.	(none)
`Paging__MaximumPageSize`	The maximum number of items that can be requested in a single page.	`100`
`GeneratorId`	The ID of the instance for distributed ID generation. Should be unique for each running instance of the API.	`0`
`ASPNETCORE_ENVIRONMENT`	The runtime environment. Set to `Development` for development-specific features.	`Production`
`ASPNETCORE_URLS`	The URLs the web host will listen on.	`http://+:8080`

API Documentation

The API includes built-in documentation, which is available when the application is running.

Swagger UI: http://localhost:8080/swagger
Scalar: http://localhost:8080/scalar

Health Checks

The application provides a health check endpoint to monitor its status.

Endpoint: http://localhost:8080/healthchecks

Building from Source

Prerequisites

.NET 10 SDK
Docker, for Testcontainers-backed integration tests
An identity provider like FusionAuth running.

Instructions

Set up User Secrets: The application requires secrets for the database connection string and identity configuration.

dotnet user-secrets set"ConnectionStrings:MongoDB""your-mongodb-connection-string"
dotnet user-secrets set"Identity:Audience""your-jwt-audience"
dotnet user-secrets set"Identity:ApiKey""your-fusionauth-api-key"

Restore dependencies and run the application:

dotnet restore
dotnet run --project src/API.Web

The API will be available at http://localhost:5000 (or as configured in launchSettings.json).

Testing

Integration tests use Testcontainers and require a running Docker daemon. Run the integration suite with:

dotnet test tests/API.IntegrationTests/API.IntegrationTests.csproj

FossaApp API

The FossaApp API provides backend services for a business management application. It handles entities such as Companies, Employees, and Branches, and includes features for authentication, authorization, and software licensing.

Getting Started

The easiest way to run the API is by using Docker.

Prerequisites

Docker

Running with Docker

Create a .env file with the required configuration variables (see the Configuration section below).
Run the Docker container:
```
docker run --rm -it -p 8080:8080 --env-file .env tiksn/fossa-api:latest
```
This image supports multiple architectures (linux/amd64, linux/arm64).

Configuration

The API is configured using environment variables. The following table lists the available variables:

Variable	Description	Default Value
`ConnectionStrings__MongoDB`	The connection string for the MongoDB database.	(none)
`Identity__RootAddress`	The root URL of the identity provider (e.g., FusionAuth).	`http://localhost:9011/`
`Identity__Audience`	The audience for the JWT tokens.	(none)
`Identity__ApiKey`	The API key for communicating with the identity provider.	(none)
`Paging__MaximumPageSize`	The maximum number of items that can be requested in a single page.	`100`
`GeneratorId`	The ID of the instance for distributed ID generation. Should be unique for each running instance of the API.	`0`
`ASPNETCORE_ENVIRONMENT`	The runtime environment. Set to `Development` for development-specific features.	`Production`
`ASPNETCORE_URLS`	The URLs the web host will listen on.	`http://+:8080`

API Documentation

The API includes built-in documentation, which is available when the application is running.

Swagger UI: http://localhost:8080/swagger
Scalar: http://localhost:8080/scalar

Health Checks

The application provides a health check endpoint to monitor its status.

Endpoint: http://localhost:8080/healthchecks

Building from Source

Prerequisites

.NET 10 SDK
Docker, for Testcontainers-backed integration tests
An identity provider like FusionAuth running.

Instructions

Set up User Secrets: The application requires secrets for the database connection string and identity configuration.

dotnet user-secrets set"ConnectionStrings:MongoDB""your-mongodb-connection-string"
dotnet user-secrets set"Identity:Audience""your-jwt-audience"
dotnet user-secrets set"Identity:ApiKey""your-fusionauth-api-key"

Restore dependencies and run the application:

dotnet restore
dotnet run --project src/API.Web

The API will be available at http://localhost:5000 (or as configured in launchSettings.json).

Testing

Integration tests use Testcontainers and require a running Docker daemon. Run the integration suite with:

dotnet test tests/API.IntegrationTests/API.IntegrationTests.csproj

FossaApp API

The FossaApp API provides backend services for a business management application. It handles entities such as Companies, Employees, and Branches, and includes features for authentication, authorization, and software licensing.

Getting Started

The easiest way to run the API is by using Docker.

Prerequisites

Docker

Running with Docker

Create a .env file with the required configuration variables (see the Configuration section below).
Run the Docker container:
```
docker run --rm -it -p 8080:8080 --env-file .env tiksn/fossa-api:latest
```
This image supports multiple architectures (linux/amd64, linux/arm64).

Configuration

The API is configured using environment variables. The following table lists the available variables:

Variable	Description	Default Value
`ConnectionStrings__MongoDB`	The connection string for the MongoDB database.	(none)
`Identity__RootAddress`	The root URL of the identity provider (e.g., FusionAuth).	`http://localhost:9011/`
`Identity__Audience`	The audience for the JWT tokens.	(none)
`Identity__ApiKey`	The API key for communicating with the identity provider.	(none)
`Paging__MaximumPageSize`	The maximum number of items that can be requested in a single page.	`100`
`GeneratorId`	The ID of the instance for distributed ID generation. Should be unique for each running instance of the API.	`0`
`ASPNETCORE_ENVIRONMENT`	The runtime environment. Set to `Development` for development-specific features.	`Production`
`ASPNETCORE_URLS`	The URLs the web host will listen on.	`http://+:8080`

API Documentation

The API includes built-in documentation, which is available when the application is running.

Swagger UI: http://localhost:8080/swagger
Scalar: http://localhost:8080/scalar

Health Checks

The application provides a health check endpoint to monitor its status.

Endpoint: http://localhost:8080/healthchecks

Building from Source

Prerequisites

.NET 10 SDK
Docker, for Testcontainers-backed integration tests
An identity provider like FusionAuth running.

Instructions

Set up User Secrets: The application requires secrets for the database connection string and identity configuration.

dotnet user-secrets set"ConnectionStrings:MongoDB""your-mongodb-connection-string"
dotnet user-secrets set"Identity:Audience""your-jwt-audience"
dotnet user-secrets set"Identity:ApiKey""your-fusionauth-api-key"

Restore dependencies and run the application:

dotnet restore
dotnet run --project src/API.Web

The API will be available at http://localhost:5000 (or as configured in launchSettings.json).

Testing

Integration tests use Testcontainers and require a running Docker daemon. Run the integration suite with:

dotnet test tests/API.IntegrationTests/API.IntegrationTests.csproj

Name		Name	Last commit message	Last commit date
.config		.config
.github		.github
.vscode		.vscode
src		src
tests		tests
.build.ps1		.build.ps1
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.gitignore		.gitignore
.gitleaksignore		.gitleaksignore
API.slnx		API.slnx
Directory.Build.props		Directory.Build.props
Directory.Packages.props		Directory.Packages.props
LICENSE		LICENSE
README.md		README.md
Set-UserSecrets.ps1		Set-UserSecrets.ps1
build.ps1		build.ps1
format.ps1		format.ps1
gig.ps1		gig.ps1
global.json		global.json
lint.ps1		lint.ps1
nuget.config		nuget.config
pack.ps1		pack.ps1
publish.ps1		publish.ps1
restore.ps1		restore.ps1
test.ps1		test.ps1
trigger.ps1		trigger.ps1
version.ps1		version.ps1

Name		Name	Last commit message	Last commit date
.config		.config
.github		.github
.vscode		.vscode
src		src
tests		tests
.build.ps1		.build.ps1
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.gitignore		.gitignore
.gitleaksignore		.gitleaksignore
API.slnx		API.slnx
Directory.Build.props		Directory.Build.props
Directory.Packages.props		Directory.Packages.props
LICENSE		LICENSE
README.md		README.md
Set-UserSecrets.ps1		Set-UserSecrets.ps1
build.ps1		build.ps1
format.ps1		format.ps1
gig.ps1		gig.ps1
global.json		global.json
lint.ps1		lint.ps1
nuget.config		nuget.config
pack.ps1		pack.ps1
publish.ps1		publish.ps1
restore.ps1		restore.ps1
test.ps1		test.ps1
trigger.ps1		trigger.ps1
version.ps1		version.ps1

Name		Name	Last commit message	Last commit date
.config		.config
.github		.github
.vscode		.vscode
src		src
tests		tests
.build.ps1		.build.ps1
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.gitignore		.gitignore
.gitleaksignore		.gitleaksignore
API.slnx		API.slnx
Directory.Build.props		Directory.Build.props
Directory.Packages.props		Directory.Packages.props
LICENSE		LICENSE
README.md		README.md
Set-UserSecrets.ps1		Set-UserSecrets.ps1
build.ps1		build.ps1
format.ps1		format.ps1
gig.ps1		gig.ps1
global.json		global.json
lint.ps1		lint.ps1
nuget.config		nuget.config
pack.ps1		pack.ps1
publish.ps1		publish.ps1
restore.ps1		restore.ps1
test.ps1		test.ps1
trigger.ps1		trigger.ps1
version.ps1		version.ps1

Name		Name	Last commit message	Last commit date
.config		.config
.github		.github
.vscode		.vscode
src		src
tests		tests
.build.ps1		.build.ps1
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.gitignore		.gitignore
.gitleaksignore		.gitleaksignore
API.slnx		API.slnx
Directory.Build.props		Directory.Build.props
Directory.Packages.props		Directory.Packages.props
LICENSE		LICENSE
README.md		README.md
Set-UserSecrets.ps1		Set-UserSecrets.ps1
build.ps1		build.ps1
format.ps1		format.ps1
gig.ps1		gig.ps1
global.json		global.json
lint.ps1		lint.ps1
nuget.config		nuget.config
pack.ps1		pack.ps1
publish.ps1		publish.ps1
restore.ps1		restore.ps1
test.ps1		test.ps1
trigger.ps1		trigger.ps1
version.ps1		version.ps1

Name		Name	Last commit message	Last commit date
.config		.config
.github		.github
.vscode		.vscode
src		src
tests		tests
.build.ps1		.build.ps1
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.gitignore		.gitignore
.gitleaksignore		.gitleaksignore
API.slnx		API.slnx
Directory.Build.props		Directory.Build.props
Directory.Packages.props		Directory.Packages.props
LICENSE		LICENSE
README.md		README.md
Set-UserSecrets.ps1		Set-UserSecrets.ps1
build.ps1		build.ps1
format.ps1		format.ps1
gig.ps1		gig.ps1
global.json		global.json
lint.ps1		lint.ps1
nuget.config		nuget.config
pack.ps1		pack.ps1
publish.ps1		publish.ps1
restore.ps1		restore.ps1
test.ps1		test.ps1
trigger.ps1		trigger.ps1
version.ps1		version.ps1

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

FossaApp API

Getting Started

Prerequisites

Running with Docker

Configuration

API Documentation

Health Checks

Building from Source

Prerequisites

Instructions

Testing

About

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

FossaApp API

Getting Started

Prerequisites

Running with Docker

Configuration

API Documentation

Health Checks

Building from Source

Prerequisites

Instructions

Testing

About

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

FossaApp API

Getting Started

Prerequisites

Running with Docker

Configuration

API Documentation

Health Checks

Building from Source

Prerequisites

Instructions

Testing

About

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Uh oh!

Latest commit