# Customer Portal documentation

> Build, extend, and contribute to the publicly developed Customer Portal for Nuxt. Verified against source revision master.

## Documentation Sets

- [Customer Portal — full documentation](https://nuxt-customer-portal.com/llms-full.txt): Architecture, setup, operations, feature-layer development, modules, and contribution guides for Customer Portal, verified against source revision master.

## Getting Started

- [Introduction](https://nuxt-customer-portal.com/raw/getting-started.md): Understand what Customer Portal provides, how it is structured, and where to begin.
- [Installation](https://nuxt-customer-portal.com/raw/getting-started/installation.md): Install the Nuxt Customer Portal packages, configure PostgreSQL, and run the provider migrations.
- [Configuration](https://nuxt-customer-portal.com/raw/getting-started/usage.md): Configure URLs, registration, authentication providers, email delivery, and administrator access.
- [Deployment](https://nuxt-customer-portal.com/raw/getting-started/deployment.md): Build Customer Portal, apply migrations safely, configure its public origin, and verify a production release.
- [AI and machine-readable documentation](https://nuxt-customer-portal.com/raw/getting-started/ai-access.md): Use raw Markdown, llms.txt, and the documentation MCP server with AI development tools.
- [Customize and brand the portal](https://nuxt-customer-portal.com/raw/getting-started/customization.md): Build a host-owned shell while reusing neutral portal primitives and feature contributions.

## Architecture

- [Architecture overview](https://nuxt-customer-portal.com/raw/architecture/overview.md): How the thin host, portal core, and feature layers combine into one Customer Portal application.
- [Nuxt layers](https://nuxt-customer-portal.com/raw/architecture/layers.md): Compose official npm layers and local providers through the package-ready portal configuration.
- [Portal-core contracts](https://nuxt-customer-portal.com/raw/architecture/core-contracts.md): Navigation, modules, dashboard widgets, audiences, and policies exposed to feature layers.
- [Tenancy and security](https://nuxt-customer-portal.com/raw/architecture/tenancy-and-security.md): How Customer Portal scopes data, separates roles, and protects feature APIs.
- [Database migrations](https://nuxt-customer-portal.com/raw/architecture/database-migrations.md): Apply package-owned PostgreSQL migration providers safely and adopt the recognized legacy history.

## Modules

- [Module overview](https://nuxt-customer-portal.com/raw/modules/overview.md): The foundation and optional business packages shipped with Nuxt Customer Portal.
- [Timesheets and invoices](https://nuxt-customer-portal.com/raw/modules/timesheets-invoices.md): A production Customer Portal feature for time entry, approvals, supplier collaboration, reporting, and invoicing.
- [Service requests](https://nuxt-customer-portal.com/raw/modules/service-requests.md): A compact reference feature showing the complete Customer Portal layer lifecycle.
- [Platform layers](https://nuxt-customer-portal.com/raw/modules/platform-layers.md): Understand the reusable foundation packages, their ownership boundaries, and host-owned presentation.

## Reference

- [Reference](https://nuxt-customer-portal.com/raw/reference.md): Look up Customer Portal configuration, feature contracts, server APIs, and compatibility guarantees.
- [Configuration reference](https://nuxt-customer-portal.com/raw/reference/configuration.md): Customer Portal environment variables, defaults, precedence, secrets, and production checks.
- [Feature contract reference](https://nuxt-customer-portal.com/raw/reference/feature-contract.md): Exact Customer Portal registry fields for navigation, modules, widgets, audiences, and authorization policies.
- [Server API and OpenAPI](https://nuxt-customer-portal.com/raw/reference/server-api.md): Discover Customer Portal endpoints and build authenticated, tenant-scoped feature APIs.
- [Compatibility and releases](https://nuxt-customer-portal.com/raw/reference/compatibility-and-releases.md): Alpha package compatibility, linked versioning, migrations, and MIT licensing.
- [Glossary](https://nuxt-customer-portal.com/raw/reference/glossary.md): Shared Customer Portal terminology for architecture, tenancy, modules, permissions, timesheets, and distribution.
- [Product source map](https://nuxt-customer-portal.com/raw/reference/source-map.md): Open the Nuxt Customer Portal monorepo files behind packages, demos, migrations, and boundary checks.

## Operations

- [Operations](https://nuxt-customer-portal.com/raw/operations.md): Run, monitor, recover, and troubleshoot a production Customer Portal deployment.
- [Backup and restore](https://nuxt-customer-portal.com/raw/operations/backup-and-restore.md): Back up Customer Portal data, protect sensitive archives, and verify recovery on an isolated PostgreSQL database.
- [Troubleshooting](https://nuxt-customer-portal.com/raw/operations/troubleshooting.md): Diagnose Customer Portal startup, database, authentication, email, and feature-layer problems.
- [Observability](https://nuxt-customer-portal.com/raw/operations/observability.md): Monitor Customer Portal with its current runtime signals and establish a production reliability baseline.
- [Upgrade recovery](https://nuxt-customer-portal.com/raw/operations/upgrade-recovery.md): Recover safely from failed Customer Portal migrations, startup failures, and post-release regressions.

## User Guides

- [User guides](https://nuxt-customer-portal.com/raw/guides.md): Complete everyday Customer Portal tasks as a member, approver, client reviewer, or organization administrator.
- [Accounts and organizations](https://nuxt-customer-portal.com/raw/guides/account-and-organizations.md): Register, verify an account, accept invitations, switch organizations, and understand portal roles.
- [Use the dashboard](https://nuxt-customer-portal.com/raw/guides/dashboard.md): Understand role-aware widgets, active-organization context, and the work Customer Portal brings to your attention.
- [Administer the portal](https://nuxt-customer-portal.com/raw/guides/system-administration.md): Manage portal users, organizations, memberships, sessions, and feature access as a system administrator.
- [Use service requests](https://nuxt-customer-portal.com/raw/guides/service-requests.md): Create, find, update, and manage tenant-scoped service requests in Customer Portal.
- [Set up a timesheet workspace](https://nuxt-customer-portal.com/raw/guides/timesheet-setup.md): Configure clients, activities, projects, team rates, approvals, and invoice defaults before work begins.
- [Record and submit time](https://nuxt-customer-portal.com/raw/guides/time-entry.md): Add weekly entries, use the running timer, correct rejected work, and submit a timesheet.
- [Approve timesheets](https://nuxt-customer-portal.com/raw/guides/approvals.md): Configure internal approvers, review submitted weeks, and manage client approval or dispute workflows.
- [Report on recorded time](https://nuxt-customer-portal.com/raw/guides/timesheet-reporting.md): Filter, interpret, and export organization timesheet data for operational and financial follow-up.
- [Create and manage invoices](https://nuxt-customer-portal.com/raw/guides/invoicing.md): Turn approved time into invoices, deliver PDFs and attachments, send reminders, and register payments.

## Contributing

- [Contributing](https://nuxt-customer-portal.com/raw/contributing.md): Help improve Customer Portal through code, documentation, testing, design, and reusable feature layers.
- [Create a feature layer](https://nuxt-customer-portal.com/raw/contributing/create-a-layer.md): Author a local Nuxt layer with public portal contracts, feature contributions, and its own migration provider.
- [Distribute a feature layer](https://nuxt-customer-portal.com/raw/contributing/distribute-a-layer.md): Package a Nuxt layer with explicit exports, peers, manifests, migrations, and clean-consumer verification.
- [Documentation contributions](https://nuxt-customer-portal.com/raw/contributing/documentation.md): Write useful, verifiable Customer Portal documentation and preview it locally.
- [Testing contributions](https://nuxt-customer-portal.com/raw/contributing/testing.md): Verify feature contracts, authorization, locales, migrations, UI behavior, and layer portability before review.
- [Propose a module](https://nuxt-customer-portal.com/raw/contributing/propose-a-module.md): Shape a reusable Customer Portal capability before investing in a new feature layer.
- [Community and support](https://nuxt-customer-portal.com/raw/contributing/community.md): Choose the right Customer Portal channel for questions, bugs, documentation, module proposals, and security reports.