# AspFox

## Docs

- [Email Setup via Resend](https://docs.aspfox.com/configuration/email-setup.md): Configure Resend for local email testing and production sending from your verified domain.
- [Environment Variables](https://docs.aspfox.com/configuration/environment-variables.md): Every environment variable in .env.example, what it does, and example values.
- [JWT Key Generation](https://docs.aspfox.com/configuration/jwt-keys.md): Generate an RSA 4096-bit key pair and add it to your .env file.
- [OAuth Configuration](https://docs.aspfox.com/configuration/oauth-setup.md): Set up Google and GitHub OAuth for social login.
- [Stripe Setup](https://docs.aspfox.com/configuration/stripe-setup.md): Configure Stripe for local development with the CLI and for production with live keys and webhook endpoints.
- [Architecture](https://docs.aspfox.com/core-concepts/architecture.md): Clean Architecture, CQRS with MediatR, and the reasoning behind the technical choices.
- [Authentication](https://docs.aspfox.com/core-concepts/authentication.md): JWT RS256, rotating refresh tokens with reuse detection, OAuth, magic links, and impersonation.
- [Background Jobs](https://docs.aspfox.com/core-concepts/background-jobs.md): Four Hangfire jobs for trial management, subscription sync, token cleanup, and invitation cleanup.
- [Dark Mode and Theming](https://docs.aspfox.com/core-concepts/dark-mode-theming.md): CSS variable theming with next-themes, semantic Tailwind classes, and brand color customization.
- [Multi-Tenancy](https://docs.aspfox.com/core-concepts/multi-tenancy.md): Row-level tenant isolation enforced at the ORM level, not just the API layer.
- [Notification System](https://docs.aspfox.com/core-concepts/notifications.md): In-app notifications with Redis-cached unread counts, automatic creation from backend events, and full tenant isolation.
- [Roles and Permissions](https://docs.aspfox.com/core-concepts/rbac-permissions.md): Three built-in roles, ten granular permissions, dynamic policy enforcement, and custom role creation.
- [Stripe Billing](https://docs.aspfox.com/core-concepts/stripe-billing.md): Three plans with free trials, Stripe Checkout, idempotent webhook processing, and Redis-cached subscription status.
- [Deployment Overview](https://docs.aspfox.com/deployment/deployment-overview.md): Compare Railway, Render, and VPS deployment options.
- [Production Checklist](https://docs.aspfox.com/deployment/production-checklist.md): Required checks before going live. Security, Stripe, email, database, OAuth, and frontend.
- [Deploy to Railway](https://docs.aspfox.com/deployment/railway.md): Step-by-step: deploy the AspFox API and frontend to Railway with managed PostgreSQL and Redis.
- [Deploy to Render](https://docs.aspfox.com/deployment/render.md): Deploy AspFox to Render using render.yaml infrastructure-as-code configuration.
- [Deploy to VPS with Docker](https://docs.aspfox.com/deployment/vps-docker.md): Ubuntu 22.04 VPS deployment with Docker Compose, Nginx reverse proxy, and Let's Encrypt SSL.
- [What is AspFox](https://docs.aspfox.com/getting-started/introduction.md): A .NET 8 SaaS boilerplate that scaffolds a complete, renamed, production-ready application in two commands.
- [Prerequisites](https://docs.aspfox.com/getting-started/prerequisites.md): Everything you need installed before running the quickstart.
- [Project Structure](https://docs.aspfox.com/getting-started/project-structure.md): What every folder and project in the scaffolded codebase is responsible for.
- [Quickstart](https://docs.aspfox.com/getting-started/quickstart.md): From purchase to running application in nine steps.
- [Adding a Feature End to End](https://docs.aspfox.com/guides/adding-a-feature.md): Complete walkthrough adding a Projects feature — domain entity to React page.
- [Adding a Database Entity](https://docs.aspfox.com/guides/adding-an-entity.md): Quick reference for the entity → configuration → migration → DbSet pattern.
- [Command Palette](https://docs.aspfox.com/guides/command-palette.md): Using the Cmd+K command palette, what commands are available, and how to add your own.
- [Customizing Email Templates](https://docs.aspfox.com/guides/customizing-email-templates.md): Change copy, update brand colors, add a logo, and create new email templates.
- [Customizing Roles and Permissions](https://docs.aspfox.com/guides/customizing-roles.md): Add permissions, create custom roles, and understand when permission changes take effect.
- [Local Development](https://docs.aspfox.com/guides/local-development.md): Day-to-day development workflow, hot reload, and the full Makefile reference.
- [Working with Stripe](https://docs.aspfox.com/guides/working-with-stripe.md): Change prices, add a plan, test billing locally, and recover from missed webhooks.
- [API Reference](https://docs.aspfox.com/reference/api-endpoints.md): All endpoints organized by controller — method, path, auth requirements, and description.
- [Error Codes](https://docs.aspfox.com/reference/error-codes.md): Every error code the API returns, the HTTP status it maps to, and when it occurs.
- [Background Job Schedules](https://docs.aspfox.com/reference/job-schedules.md): Cron schedules, batch sizes, retry behavior, and what to do when a job fails.
- [Notification Types](https://docs.aspfox.com/reference/notification-types.md): All notification types, when they are created, who receives them, and whether they include an action URL.
- [Stripe Webhook Events](https://docs.aspfox.com/reference/webhook-events.md): The five Stripe events AspFox handles, what triggers each, and what local state changes result.

## OpenAPI Specs

- [openapi](https://docs.aspfox.com/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/aspfox/aspfox)
- [Changelog](https://github.com/aspfox/aspfox-private/blob/main/CHANGELOG.md)
- [Support](https://github.com/aspfox/aspfox/issues)