Skip to contents

Proprietary - Do Not Distribute


Environment Variables

Each deployment environment (dev, prod, site) sets these variables directly. No config switching required.

Database Connection

Variable Description
ART_PGHOST PostgreSQL host
ART_PGPORT PostgreSQL port
ART_PGUSER PostgreSQL username
ART_PGPASS PostgreSQL password
ART_PGDATA PostgreSQL database name

CDN (DigitalOcean Spaces)

Variable Description
ART_BUCKETS_KEY_ID Spaces access key ID
ART_BUCKETS_KEY_SECRET Spaces secret key

Application Mode

Variable Description
ART_RUNAS_DEMO TRUE or FALSE - enables demo mode where writes are ignored

Documentation Site

The package documentation is hosted at https://artalytics.github.io/artcore

Building Locally

Prerequisites: - Pandoc (or winget install JohnMacFarlane.Pandoc on Windows)

# Install pkgdown if needed
install.packages("pkgdown")

# Build the full site
pkgdown::build_site()

# Preview in browser
pkgdown::preview_site()

For faster iteration on specific sections:

# Rebuild only the home page
pkgdown::build_home()

# Rebuild only the reference index
pkgdown::build_reference_index()

# Rebuild a single article
pkgdown::build_article("artcore")

# Initialize site (useful after changing styles/colors)
pkgdown::init_site()

The site will be generated in the docs/ directory. For local preview with working search, use:

servr::httw("docs")

For AI Agents

See AGENTS.md for development guidance, build instructions, and coding standards.