analytics/README.md

# Strata.Analytics

[![build](https://github.com/stratadecision/analytics/actions/workflows/build.yaml/badge.svg)](https://github.com/stratadecision/analytics/actions/workflows/build.yaml)

[![Strata.Analytics.Octopus](https://img.shields.io/badge/octopus-Strata.Analytics-004880?logo=OctopusDeploy)](https://octopus.sdt.local/app#/Spaces-1/projects/analytics)

[![SonarQube](https://img.shields.io/badge/SonarQube-Strata.Analytics-004880?logo=sonarqube)](https://sonarqube.ops.stratanetwork.net/dashboard?id=Strata.Analytics)

[![Strata.Analytics.Client](https://img.shields.io/badge/nuget-Strata.Analytics.Client-004880?logo=nuget&logoColor=004880)](https://proget.ops.stratanetwork.net/feeds/nuget/Strata.Analytics.Client/versions?HidePrerelease=True)

[![Strata.Analytics.Api](https://img.shields.io/badge/api-Strata.Analytics-004880?logo=swagger&logoColor=00FF00)](https://analytics-api.dev.stratanetwork.net)

[![Strata.Analytics.Web](https://img.shields.io/badge/web-Strata.Analytics-004880?logo=react&logoColor=61DBFB)](https://analytics.dev.stratanetwork.net)

[![Strata.Analytics.Hangfire](https://img.shields.io/badge/hangfire-Strata.Analytics-004880?logo=MediaFire&logoColor=FF0000)](https://analytics-dashboard.dev.stratanetwork.net)

## Branching and Versioning

### Epic / Feature branches
For epics / features that have multiple stories or are a big chunk of work, use feature release branches.  There should be a feature release `main` branch and all PRs for that feature will use that as the base.  When the entire feature is ready to be deployed, merge the feature release `main` back into `main main`.

For example, if the feature is for `Content Migration`, create the feature release main as `feature/[team]/release/content-migration/main`.  For stories tied to that feature (for example, JAZZ-4231), branch off the feature release main and name it `feature/[team]/release/content-migration/JAZZ-4231-content-migration-mapping`.

### Bugs / Small Changes
For bugs and small changes, use regular `feature/[team]/JAZZ-1234-description` and `fix/[team]/JAZZ-1234-description` branches that will be merged into main


## Usage

### AWS Profile
```
[profile sdt-analytics-service-role]
source_profile = 809820578507_SDT-Dev-Developers
role_arn = arn:aws:iam::809820578507:role/sdt-analytics-service-role
region=us-east-1
```

### Build and Run

```
docker-compose up -d --build
```

- https://localhost:8443/index (swagger api)
- https://localhost:8443/hangfire (hangfire dashboard)
- http://localhost:8081 (redis commander)

### Extracting nuget package

```
docker create --name throwaway strataanalytics_analytics-api
docker cp throwaway:/pack .
docker rm throwaway
```

### Cleanup

```
docker-compose down
```