chore: initial project scaffolding with .gitignore, README, and license

This commit is contained in:
Stevan Freeborn
2026-07-29 16:29:03 -05:00
commit 6d9ef720f1
3 changed files with 80 additions and 0 deletions
+2
View File
@@ -0,0 +1,2 @@
certs/
docs/
+19
View File
@@ -0,0 +1,19 @@
# Copyright (c) 2026 Stevan Freeborn
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+59
View File
@@ -0,0 +1,59 @@
# ParagonPlayground — Getting Started
A application harness to explore using Paragon for integrations.
## Prerequisites
- Docker Desktop
- .NET 10 SDK
- Node.js 24+
## Setup
### 1. Generate TLS certificates
```powershell
# Run once to create + trust a local CA and sign a wildcard cert
.\scripts\setup-certs.ps1
```
> **Run this from an elevated (Admin) PowerShell prompt.** `mkcert` needs admin rights to install the CA into the JDK system trust store. Without elevation the OS and browsers still trust the cert, but Java tools will reject it.
This uses [mkcert](https://github.com/FiloSottile/mkcert) (installed automatically if missing). No hosts file entries needed — `*.paragonplayground.localhost` resolves to 127.0.0.1 natively.
### 2. Start infrastructure
```bash
cd src\ParagonPlayground
docker compose -f docker-compose.dev.yml up -d
```
### 3. Seed data (via CLI)
```bash
cd src\ParagonPlayground\backend
dotnet run --project src\ParagonPlayground.Cli -- provision seed
```
Or create your own org + user:
```bash
dotnet run --project src\ParagonPlayground.Cli -- provision org --name "Test Corp" --slug testcorp
dotnet run --project src\ParagonPlayground.Cli -- provision user --email admin@testcorp.com --password s3cret --name "Admin" --org-slug testcorp
```
### 4. Open the app
Navigate to **https://acme.paragonplayground.localhost** and sign in with:
- **Email:** alice@acme.com
- **Password:** password123
## CLI Reference
```bash
# Run from the backend directory
dotnet run --project src\ParagonPlayground.Cli -- provision org --name "Name" --slug name
dotnet run --project src\ParagonPlayground.Cli -- provision user --email e@x.com --password p --name "User" --org-slug name
dotnet run --project src\ParagonPlayground.Cli -- provision seed
```