Getting Started¶
Status: Complete | Last updated: 2026-04-15
Quick-start guide for new developers joining the Progress Credit Union v17 project.
Prerequisites¶
| Tool | Version | Download |
|---|---|---|
| .NET SDK | 10.0+ | dotnet.microsoft.com |
| Git | Any | git-scm.com |
| Docker Desktop | Latest | docker.com |
| Node.js | 20+ | nodejs.org (for custom property editors) |
| SQL Server | 2019+ | Local install, Docker, or Azure SQL |
Verify your setup:
Quick Start¶
1. Clone the Repository¶
git clone https://dev.azure.com/ProgressSystemsLtd/CUCloud.Web/_git/psCreditUnion -b feature/upg-v17-double
cd psCreditUnion
2. Restore a Database Template¶
The recommended starting point is to restore a .bacpac database template. This gives you a fully configured Umbraco instance with all content types, data types, templates, dictionary items, and sample content already in place.
# Option A: Using sqlpackage (recommended)
sqlpackage /Action:Import /TargetServerName:localhost /TargetDatabaseName:progress_cms /SourceFile:path/to/template.bacpac
# Option B: Using Docker SQL Server
docker run -d --name progress-sql -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=YourPassword1!" -e "MSSQL_PID=Developer" -p 1433:1433 mcr.microsoft.com/mssql/server:2022-latest
Update the connection string in dbl.Progress/src/www/appsettings.Development.json to point to your database.
3. Install Azure Artifacts Credential Provider¶
The project uses a private NuGet feed on Azure Artifacts. Install the credential provider once:
4. Build and Run¶
dotnet restore dbl.Progress/dbl.Progress.sln
dotnet build dbl.Progress/dbl.Progress.sln -c Debug
dotnet run --project dbl.Progress/src/www/www.csproj
First restore triggers browser login
The first dotnet restore will open a browser window for Azure AD authentication against the Azure Artifacts feed.
The site starts at https://localhost:5001. The Umbraco backoffice is at /umbraco.
5. Build Custom Property Editors (Optional)¶
If you need to work on the backoffice property editors:
What You Get¶
After building, the project contains:
- 190+ Razor views — page templates, BlockGrid/BlockList components, site layout partials
- 172 client CSS themes — one per credit union
- 31 custom property editors — TypeScript backoffice extensions
- 555+ content types — document types and element types
- 666 data types — property editor configurations
Next Steps¶
- Developer Guide — Full development workflow, project structure, service APIs
- Quick Start — New Client Project — Creating a new credit union site from the template
- Adding a New Client — End-to-end client onboarding with Azure deployment
- Grid Architecture — Understanding the 4-level BlockGrid hierarchy