Skip to main content

Documentation Index

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

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

The Developers tab covers the technical surface of Archie — APIs, custom functions, data access, integrations, environments, and GitHub workflow. This is for engineers building or extending Archie-generated apps directly in code. If you are looking for product-level documentation (blueprints, building, deployment), see the Introduction tab.

​
The Backend Console

The Backend Console is the central command center for your application’s server-side logic, data architecture, and infrastructure. It provides a unified interface to manage your database, explore your auto-generated APIs, and configure essential application services.

​
Data Model

The Data Model is the foundation of your application. Define the structure of your database without writing complex migration scripts.
  • Tables: Create and manage database tables (e.g., users, audit_events) to store your application records.
  • Schema & Fields: Define specific data types (Text, Number, Date, UUID) and configure relationships between tables.
  • Views & Data Types: Create SQL Views for complex data aggregation and define reusable Data Types (Enums) to standardize values across your schema.
See Data → Data Model.

​
GraphQL API Explorer

The GraphQL API Explorer is an integrated GraphiQL environment that allows you to interact directly with your application’s API.
  • Auto-generated API: The system automatically generates GraphQL Queries, Mutations, and Subscriptions based on your Data Model.
  • Composer: A visual tool to build queries by simply clicking fields, eliminating the need to type syntax manually.
  • Documentation: Access real-time, inline documentation for your schema to understand available fields and arguments.
See APIs → API Explorer.

​
REST API Explorer

The REST API Explorer provides a comprehensive Swagger UI environment to test and interact with your auto-generated RESTful endpoints.
  • Standardized endpoints: Instantly test GET, POST, PUT, and DELETE operations for all your data models without any manual setup.
  • Interactive testing: Execute API requests directly from the browser, passing parameters, headers, and request bodies easily.
  • OpenAPI documentation: Access fully detailed OpenAPI (Swagger) documentation that automatically stays in sync with your data schema.
See APIs → REST API Explorer.

​
SQL Playground

For advanced data operations, the SQL Playground provides a raw SQL editor.
  • Direct access: Execute standard SQL queries (SELECT, JOIN, etc.) directly against your database tables.
  • Debugging: Ideal for testing complex logic or debugging data issues that are difficult to trace via the GraphQL API.
See Data → SQL Playground.

​
Integrations

Extend the capabilities of your application by connecting third-party services via the Integrations module.
  • Communication: Connect Slack or Twilio for messaging.
  • Email: Configure SendGrid for transactional emails.
  • Payments: Integrate Stripe for processing payments.
  • E-commerce: Integrate Shopify for managing your online store and products.
See Integrations → Overview.

​
App Services

App Services manage the core infrastructure components required for a modern application:
  • File Manager: Configure storage providers like AWS S3, Google Cloud Storage, Filestack, or Azure Blob Storage to handle user uploads and file assets.
  • Authentication Providers: Set up secure login methods using the built-in Archie Auth, or external providers like Auth0, Google, AWS Cognito, or standard API Tokens.
  • Roles (RBAC): Define Role-Based Access Control to manage permissions and restrict what different users (e.g., Admin, Customer) can see or do.
Note: Authentication providers, gateway routes, file storage providers, and roles are all configured per environment. This guarantees isolation and allows you to maintain independent configurations for development, testing, and production.

​
Environments

The Environments feature provides Git-like branching for your entire backend, enabling isolated development, testing, and staging workflows.
  • Branch: Create new environments by cloning an existing one’s database (full data or schema-only).
  • Isolate: Each environment has its own database, roles, providers, and API configuration.
  • Diff: Compare schemas between environments to see exactly what changed (tables, columns, indexes, enums, views, relationships).
  • Copy configuration: Optionally copy file providers, gateway routes, security settings, and environment variables when branching.
See Environments → Overview.

​
Settings

The Settings menu controls the global configuration and security of your project:
  • API Keys: Generate and manage API keys to allow external applications to securely connect to your backend.
  • Environment Variables: Store sensitive configuration values (like secret keys or external URLs) securely as key-value pairs.
  • Network: Configure CORS (Cross-Origin Resource Sharing) policies and set Rate Limits to protect your API from abuse.
See APIs → API Keys and Environments → Configuration.

​
What is here

​
Voice and assumptions

These pages assume you read code, run a terminal, and understand HTTP, REST, GraphQL, and your project’s stack. Where Archie’s generator produces code, examples show actual file paths and call signatures.