Installation
System Requirements
Section titled “System Requirements”| Requirement | Version |
|---|---|
| .NET SDK | 10.0+ |
| Docker | 24.0+ |
| Node.js | 20+ |
| PostgreSQL | 16+ |
| Redis | 7+ |
Step-by-Step Setup
Section titled “Step-by-Step Setup”1. Clone the Repository
Section titled “1. Clone the Repository”git clone https://github.com/your-org/dotnetsaas.gitcd dotnetsaas2. Start Dependencies
Section titled “2. Start Dependencies”The project uses PostgreSQL and Redis. Start them with Docker Compose:
docker compose up -d3. Configure the Application
Section titled “3. Configure the Application”Copy the example settings file:
cp src/DotnetSaas.Api/appsettings.Development.json.example src/DotnetSaas.Api/appsettings.Development.jsonUpdate the connection strings and configuration values as needed.
4. Run Database Migrations
Section titled “4. Run Database Migrations”The application automatically runs migrations on startup. Alternatively, you can run them manually:
cd src/DotnetSaas.Infrastructuredotnet ef database update --startup-project ../DotnetSaas.Api5. Start the Application
Section titled “5. Start the Application”Using .NET Aspire (recommended):
cd src/DotnetSaas.AppHostdotnet runOr start the API directly:
cd src/DotnetSaas.Apidotnet runFrontend Setup
Section titled “Frontend Setup”The boilerplate supports multiple frontend frameworks. Choose your preferred option:
Blazor WASM
Section titled “Blazor WASM”cd frontend/blazordotnet runReact / Angular / Vue
Section titled “React / Angular / Vue”cd frontend/react # or angular, vuenpm installnpm run devEnvironment Variables
Section titled “Environment Variables”| Variable | Description | Default |
|---|---|---|
ConnectionStrings__DefaultConnection | PostgreSQL connection string | See appsettings |
ConnectionStrings__Redis | Redis connection string | localhost:6379 |
BlazorPathBase | Base path for Blazor WASM | /blazor |
DemoMode | Enable demo data seeding | false |