Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aspfox.com/llms.txt

Use this file to discover all available pages before exploring further.

Required software

SoftwareMinimum versionWhere to get it
.NET SDK8.0dotnet.microsoft.com/download
Node.js20nodejs.org
Docker DesktopLatest stabledocker.com/products/docker-desktop
GitAnygit-scm.com
makeAnySee Windows note below
Windows: installing makeWindows does not include make by default. Install it via Chocolatey:
choco install make
Or via Scoop:
scoop install make
Alternatively, open the Makefile and run the underlying docker compose commands directly — the Makefile has comments showing the full command for each target.

External services

These services are used by AspFox. All have free tiers sufficient for local development.
ServiceRequired forFree tier
StripeBilling featuresYes — test mode is fully free
ResendTransactional emailYes — 100 emails/day
Google Cloud ConsoleGoogle OAuthYes
GitHub OAuth AppsGitHub OAuthYes
Stripe and Resend are optional for initial local development. The application starts and runs without them. Auth, multi-tenancy, and RBAC all work fully. Billing endpoints will return configuration errors, and emails will not send, but you can develop and test everything else without these services configured.

Verify your setup

Run these commands to confirm the required tools are installed:
dotnet --version    # Should print 8.0.x or higher
node --version      # Should print v20.x or higher
docker --version    # Should print Docker version 24.x or higher
docker compose version  # Should print v2.x
make --version      # Should print GNU Make 4.x
If any of these fail, install the missing tool before proceeding to the quickstart.