https://github.com/studio1902/statamic-peak

Statamic Peak is an opinionated starter kit for all your Statamic sites.
https://github.com/studio1902/statamic-peak

alpinejs antlers cookie-consent favicons fieldsets page-builder peak seo starter-kit statamic tailwind

Last synced: 1 day ago
JSON representation

Statamic Peak is an opinionated starter kit for all your Statamic sites.

• Host: GitHub
• URL: https://github.com/studio1902/statamic-peak
• Owner: studio1902
• License: gpl-3.0
• Created: 2020-07-31T09:37:21.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-26T08:52:17.000Z (3 months ago)
• Last Synced: 2024-10-29T17:12:08.582Z (3 months ago)
• Topics: alpinejs, antlers, cookie-consent, favicons, fieldsets, page-builder, peak, seo, starter-kit, statamic, tailwind
• Language: PHP
• Homepage:
• Size: 7.44 MB
• Stars: 600
• Watchers: 11
• Forks: 101
• Open Issues: 0
• Metadata Files:
  • Readme: README.example.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# site.ext

## Installation instructions

1. run `composer install`

2. run `php please make:user`

3. run `npm i` && `npm run dev`

## Environment file contents

### Development

```env

Dump your .env values here with sensitive data removed.

```

### Production

```env

Dump your .env values here with sensitive data removed. The following is a production example that uses full static caching:

APP_NAME="Statamic Peak"

APP_ENV=production

APP_KEY=

APP_DEBUG=false

APP_TIMEZONE="UTC"

APP_URL=

APP_LOCALE=en

APP_FALLBACK_LOCALE=en

APP_FAKER_LOCALE=en_US

APP_MAINTENANCE_DRIVER=file

APP_MAINTENANCE_STORE=file

BCRYPT_ROUNDS=12

LOG_CHANNEL=stack

LOG_STACK=single

LOG_DEPRECATIONS_CHANNEL=null

LOG_LEVEL=debug

DB_CONNECTION=sqlite

# DB_HOST=127.0.0.1

# DB_PORT=3306

# DB_DATABASE=laravel

# DB_USERNAME=root

# DB_PASSWORD=

SESSION_DRIVER=file

SESSION_LIFETIME=120

SESSION_ENCRYPT=false

SESSION_PATH=/

SESSION_DOMAIN=null

BROADCAST_CONNECTION=log

FILESYSTEM_DISK=local

QUEUE_CONNECTION=redis

CACHE_STORE=file

CACHE_PREFIX=

MEMCACHED_HOST=127.0.0.1

REDIS_CLIENT=phpredis

REDIS_DATABASE=

REDIS_HOST=127.0.0.1

REDIS_PASSWORD=null

REDIS_PORT=6379

MAIL_MAILER=smtp

MAIL_HOST=smtp.postmarkapp.com

MAIL_PORT=587

MAIL_ENCRYPTION=tls

MAIL_USERNAME=

MAIL_PASSWORD=

MAIL_FROM_ADDRESS=

MAIL_FROM_NAME="${APP_NAME}"

AWS_ACCESS_KEY_ID=

AWS_SECRET_ACCESS_KEY=

AWS_DEFAULT_REGION=us-east-1

AWS_BUCKET=

AWS_USE_PATH_STYLE_ENDPOINT=false

VITE_APP_NAME="${APP_NAME}"

STATAMIC_LICENSE_KEY=

STATAMIC_THEME=business

STATAMIC_PRO_ENABLED=true

STATAMIC_STACHE_WATCHER=auto

STATAMIC_STATIC_CACHING_STRATEGY=full

STATAMIC_CACHE_TAGS_ENABLED=true

STATAMIC_REVISIONS_ENABLED=false

STATAMIC_GRAPHQL_ENABLED=false

STATAMIC_API_ENABLED=false

STATAMIC_GIT_ENABLED=true

STATAMIC_GIT_PUSH=true

STATAMIC_GIT_DISPATCH_DELAY=5

#IMAGE_MANIPULATION_DRIVER=imagick

#STATAMIC_CUSTOM_CMS_NAME=

#STATAMIC_CUSTOM_LOGO_NAV_URL=

#STATAMIC_CUSTOM_DARK_LOGO_URL=

STATAMIC_CUSTOM_LOGO_OUTSIDE_URL="/visuals/client-logo.svg"

#STATAMIC_CUSTOM_FAVICON_URL=

#STATAMIC_CUSTOM_CSS_URL=

```

## 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

```bash

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}

{SITE_COMPOSER} install --no-interaction --prefer-dist --optimize-autoloader --no-dev

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

```bash

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

$FORGE_COMPOSER install --no-interaction --prefer-dist --optimize-autoloader --no-dev

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

```