feat: initial commit

2026-06-23 11:26:55 -05:00
parent d472a6cff8
commit 1e042cc5e8
722 changed files with 278037 additions and 1 deletions
@@ -1 +1,47 @@
-# strataspheredatamanagement
+# Strataspheredatamanagement
+
+## First Time Setup Notes
+
+For first time setting up AWS authentication you'll need to follow the steps here https://confluence.sdt.local/display/SWPRJ/IAM+Application+Role+Setup+for+AWS+applications#IAMApplicationRoleSetupforAWSapplications-AWSCredentialsSetup
+You will need the contents below in your AWS config file located here: %UserProfile%/.aws/config
+```
+[profile stratasphere-datawrangling]
+source_profile = 809820578507_SDT-Dev-Developers
+role_arn = arn:aws:iam::809820578507:role/SDT-data-wrangler-Service-Role
+region=us-east-1
+```
+
+### SonarQube Metrics
+
+[SonarQube](https://sonarqube.ops.stratanetwork.net/dashboard?id=Strata.StratasphereDataManagement)
+
+### Build Status
+[![build](https://github.com/stratadecision/strataspheredatamanagement/actions/workflows/build.yaml/badge.svg)](https://github.com/stratadecision/strataspheredatamanagement/actions/workflows/build.yaml)
+
+
+## Branching and Versioning
+
+| branch     | version format        | example         |
+| ---------- | --------------------- | --------------- |
+| master     | #.#.#                 | 1.2.3           |
+| feature/\* | #.#+1.0-featureName.# | 1.3.0-newfeat.1 |
+| fix/\*     | #.#.#+1-fixName.#     | 1.2.4-bug.1     |
+
+See our [confluence page](https://confluence.sdt.local/display/DOP/Branching+and+Versioning) for more information
+
+## Usage
+
+### Build and Run
+
+```
+docker-compose up --build
+```
+API - https://localhost:8443
+Web - http://localhost:3000
+
+### Extracting nuget package
+```
+docker create --name throwaway stratatemplate_template-api
+docker cp throwaway:/pack .
+docker rm throwaway
+```