Skip to content

About

The UAMS website on Statamic: the Laravel app, its blueprints, templates and add-on configuration.

Topics

Resources

Code of conduct

Contributing

Security policy

Accessibility

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

304 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Getting Started

Installation instructions

  1. Install Laravel Herd
  2. Configure "Herd paths" in Laravel Herd's general settings
  3. Install Imagick (if on Windows)
  4. Clone this repository into the Herd path.
    1. If you clone without --recurse-submodules, run git submodule update --init --recursive to fetch the content, users, resources/forms and assets submodules.
  5. Create a copy of the .env.example file as .env.
  6. Add any sensitive data to the relevant variables in .env (e.g., GOOGLE_MAPS_API_KEY).
  7. Run composer install
  8. Run php please make:user
  9. Run npm i && npm run dev:with-cp
  10. Run npx --no-install puppeteer browsers install chrome-headless-shell. News release PDFs need this browser, and npm does not download it because .npmrc sets ignore-scripts=true. Without it a published news_release saves with no PDF and the reason is only in storage/logs/laravel.log. node scripts/worktree-slots.mjs status names the browser when it is missing.
  11. Go to http://uams-statamic.test/ and click "Generate App Key"

Vendor patches

The Composer vendor patches come from the uams-web/patches-* packages; see patches/README.md.

Asset metadata (custom)

Asset rows live in SQLite and are mirrored to YAML under content/models/assets/. See docs/assets-metadata.md for architecture, sync commands, and deploy notes.

Troubleshooting

  • Public form renders without fields / Alpine never starts (504 Outdated Optimize Dep in DevTools). Vite's optimize-dep cache went stale (common after npm ci, lockfile-touching branch switches, or dep upgrades while the dev server is running). See docs/runbooks/vite-stale-optimize-dep-cache.md for symptoms, cause, and fix.

Git Submodules

This repository uses Git submodules for Statamic content, users, form configurations and asset storage so those can be versioned and deployed separately.

Submodule Path Purpose
UAMS-Web/uams-statamic-content content/ Statamic collections, taxonomies, globals
UAMS-Web/uams-statamic-users users/ Statamic user accounts and groups
UAMS-Web/uams-statamic-forms resources/forms/ Statamic form configurations
UAMS-Web/uams-statamic-assets-public public/assets/ Public asset containers (images, files, etc.)
UAMS-Web/uams-statamic-assets-private app/private/assets/ Private asset containers (form uploads, etc.)
  • Clone with submodules:
    git clone --recurse-submodules <repo-url>
  • If you already cloned without submodules:
    git submodule update --init --recursive
  • Update submodules to latest committed refs:
    git submodule update --init --recursive
    (Deploy scripts run this after git pull so production stays in sync.)

All five submodules are private repositories (UAMS-Web/uams-statamic-archive#2654). A clone without access to them gets the submodule pointers but not their contents, so it cannot boot the site with real content or forms. The test suite still runs: a test that needs content checks for the content/ submodule, and a test that reads the real form configurations checks for the resources/forms/ submodule, and each is skipped, not failed, when its submodule is absent (tests/Support/ContentSubmodule.php, tests/Support/FormsSubmodule.php). Expect those tests to report as skipped in such a clone.

Statamic Peak Starter Kit Information

See below for information about what was and wasn't added to the repository from the Statamic Peak starter kit.

NGINX config

Add the following to your NGINX config inside the server block enable static resource caching:

expires $expires;

And this outside the server block:

map $sent_http_content_type $expires {
    default    off;
    text/css    max;
    ~image/    max;
    application/javascript    max;
    application/octet-stream    max;
}

Deploy script Ploi

if [[ {COMMIT_MESSAGE} =~ "[BOT]" ]] && [[ {DEPLOYMENT_SOURCE} == "quick-deploy" ]]; then
    echo "Automatically committed on production. Nothing to deploy."
    {DO_NOT_NOTIFY}
    exit 0
fi

cd {SITE_DIRECTORY}
git pull origin {BRANCH}
git submodule update --init --recursive
{SITE_COMPOSER} install --no-interaction --prefer-dist --optimize-autoloader --no-dev

# `.npmrc` sets engine-strict against `engines.npm >= 11.10.0` (UAMS-Web/uams-statamic-archive#1826), and Node 22
# bundles npm 10.9.x — so `npm ci` fails with EBADENGINE unless npm is pinned first.
npm install -g npm@^11.10.0
npm ci
npm run build

{RELOAD_PHP_FPM}

{SITE_PHP} artisan cache:clear
{SITE_PHP} artisan config:cache
{SITE_PHP} artisan route:cache
{SITE_PHP} artisan statamic:stache:warm
{SITE_PHP} artisan queue:restart
{SITE_PHP} artisan statamic:search:update --all
{SITE_PHP} artisan statamic:static:clear
{SITE_PHP} artisan statamic:static:warm --queue

echo "Application deployed!"

Deploy script Forge

if [[ $FORGE_QUICK_DEPLOY == 1 ]]; then
    if [[ $FORGE_DEPLOY_MESSAGE =~ "[BOT]" ]]; then
        echo "Automatically committed on production. Nothing to deploy."
        exit 0
    fi
fi

cd $FORGE_SITE_PATH
git pull origin $FORGE_SITE_BRANCH
git submodule update --init --recursive
$FORGE_COMPOSER install --no-interaction --prefer-dist --optimize-autoloader --no-dev

# `.npmrc` sets engine-strict against `engines.npm >= 11.10.0` (UAMS-Web/uams-statamic-archive#1826), and Node 22
# bundles npm 10.9.x — so `npm ci` fails with EBADENGINE unless npm is pinned first.
npm install -g npm@^11.10.0
npm ci
npm run build

( flock -w 10 9 || exit 1
    echo 'Restarting FPM...'; sudo -S service $FORGE_PHP_FPM reload ) 9>/tmp/fpmlock

$FORGE_PHP artisan cache:clear
$FORGE_PHP artisan config:cache
$FORGE_PHP artisan route:cache
$FORGE_PHP artisan statamic:stache:warm
$FORGE_PHP artisan queue:restart
$FORGE_PHP artisan statamic:search:update --all
$FORGE_PHP artisan statamic:static:clear
$FORGE_PHP artisan statamic:static:warm --queue

Working copies of people entries (revisions)

A change to a published people entry is saved as a working copy and goes live only when an administrator publishes it (UAMS-Web/uams-statamic-archive#3127, UAMS-Web/uams-statamic-archive#3184). That needs STATAMIC_REVISIONS_ENABLED=true in the environment's .env; people is the only collection with revisions: true, so no other collection changes. With the setting off, a change to a published people entry is saved to the entry directly, as before.

Working copies and revision history are stored under storage/statamic/revisions (config/statamic/revisions.php), which is git-ignored and outside the content repository. So:

  • They survive a deploy only if storage/ does. Both deploy scripts above pull into the same directory, so storage/ stays in place. A deploy that builds each release in a fresh directory (zero-downtime deployment) must share storage/statamic/revisions across releases, or every pending change is lost on the next deploy.
  • They are not in the content repository's history. Include storage/statamic/revisions in the server's backups; nothing else holds a change that is waiting to be published.

Continuous integration

Remote CI runs on every pull request and on every push to main. A ruleset on main requires three checks: CI, which fails unless every other job in .github/workflows/ci.yml succeeded (the manual-only submodule-access aside), plus Attribution footer and Closing keywords. CI runs its jobs on Linux, Windows and macOS; the other two read text and run on Linux. docs/runbooks/branch-protection.md records what main enforces.

License

This repository is released under the MIT License, copyright University of Arkansas for Medical Sciences.

The license does not cover the following paths, which hold third-party material under their owners' own terms:

  • patches/: changes to third-party Composer packages, each under its package's own license.
  • resources/fonts/firago/: the FiraGO typeface, under the SIL Open Font License 1.1 (OFL.txt).
  • resources/svg/: icon artwork.
  • resources/raster_images/: photography and other raster images.
  • resources/js/uams_2020/source/genesis/: a script from the Genesis framework by StudioPress.
  • lang/vendor/statamic/: translations published from Statamic.
  • app/Services/EnumGeneration/Schema/schemaorg-current-https.jsonld: the Schema.org vocabulary, under the terms Schema.org publishes it under.

General Statamic Information

Statamic Logo

About Statamic

Statamic is the flat-first, Laravel + Git powered CMS designed for building beautiful, easy to manage websites.

Note

This repository contains the code for a fresh Statamic project that is installed via the Statamic CLI tool.

The code for the Statamic Composer package itself can be found at the Statamic core package repository.

Learning Statamic

Statamic has extensive documentation. We dedicate a significant amount of time and energy every day to improving them, so if something is unclear, feel free to open issues for anything you find confusing or incomplete. We are happy to consider anything you feel will make the docs and CMS better.

Support

We provide official developer support on Statamic Pro projects. Community-driven support is available on the forum and in Discord.

Contributing

Thank you for considering contributing to Statamic! We simply ask that you review the contribution guide before you open issues or send pull requests.

Code of Conduct

In order to ensure that the Statamic community is welcoming to all and generally a rad place to belong, please review and abide by the Code of Conduct.

Important Links

About

The UAMS website on Statamic: the Laravel app, its blueprints, templates and add-on configuration.

Topics

Resources

Code of conduct

Contributing

Security policy

Accessibility

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages