sasquatchwp/sasquatchwp

Starter stack for WordPress - mix of Foundation, Bedrock and some magic

dev-master 2021-02-09 19:57 UTC

Requires

• php: >=5.6
• composer/installers: ^1.5
• oscarotero/env: ^1.1.0
• roots/wordpress: 5.0.1
• roots/wp-config: 1.0.0
• roots/wp-password-bcrypt: 1.0.0
• soberwp/models: dev-master
• vlucas/phpdotenv: ^2.0.1

Requires (Dev)

• roave/security-advisories: dev-master
• squizlabs/php_codesniffer: ^2.0.0

MIT

• Maciej Palmowski

• composer
• wordpress
• stack
• wp
• timber
• roots
• bedrock

README

Sasquatch WP - starter pack

Description

This is SasquatchWP starter stack.

What is SasquatchWP?

It's the mix of:

• Bedrock - https://roots.io/bedrock/
• Zurb Foundation - https://github.com/zurb/foundation-sites
• Timber - https://github.com/timber/timber
• SoberWP Intervention - https://github.com/soberwp/intervention
• SoberWP Models - https://github.com/soberwp/models

and a little magic to keep it all together.

Instalation

1. git clone https://github.com/SasquatchWP/SasquatchWP.git .
2. Rename .env.example to .env and fill it with correct data (database name, password etc) - remember to add salts from here
3. Prepare .htaccess or vhost
4. composer install
5. Change theme name in web/app/themes/sasquatch
6. cd web/app/themes/{theme_name}
7. npm install
8. composer install

Remember to change DEVURL in web/app/themes/{theme_name}/config.yml

.htaccess

This is universal .htaccess you can use for shared hosting.

Example for domains (domain.test)

<Files ~ '\.(env|json|config.js|md|gitignore|gitattributes|lock)$'>
    Order allow,deny
    Deny from all
</Files>
<Files ~ '(composer.json|test.html)$'>
    Order allow,deny
    Deny from all
</Files>
RewriteEngine on
RewriteCond %{HTTP_HOST} ^(www.)?domain.test$
RewriteCond %{REQUEST_URI} !^/web/
RewriteRule ^(.*)$ /web/$1
RewriteCond %{HTTP_HOST} ^(www.)?domain.test$
RewriteRule ^(/)?$ web/index.php [L]

Example for subfolders (domain.test/subfolder)

<Files ~ '\.(env|json|config.js|md|gitignore|gitattributes|lock)$'>
    Order allow,deny
    Deny from all
</Files>
<Files ~ '(composer.json|test.html)$'>
    Order allow,deny
    Deny from all
</Files>
RewriteEngine on
RewriteCond %{HTTP_HOST} ^(www.)?domain.test$
RewriteCond %{REQUEST_URI} !^/subfolder/web/
RewriteRule ^(.*)$ /subfolder/web/$1
RewriteCond %{HTTP_HOST} ^(www.)?domain.test$
RewriteRule ^(/)?$ web/index.php [L]

vhost

Set your site vhost document root to /path/to/site/web/

Example

<VirtualHost *:80>
	ServerName domain.test
	DocumentRoot "/path/to/site/web"
	<Directory  "/path/to/site/">
		Options +Indexes +Includes +FollowSymLinks +MultiViews
		AllowOverride All
	</Directory>
</VirtualHost>

Usage

• npm run build - run all tasks for production

• npm run development - run all tasks for development (sitemaps etc)

• npm start - run tasks in watch mode

• npm es-lint - runs javascript lint - to change configuration look at .browserslistrc

• npm sass-lint - runs sass lint - to change configuration look at .sass-lint.yml

• npm audit - runs Parker audit

Where is it used

• https://bezprawnik.pl - one of the biggest law blogs in Poland
• https://autoblog.pl - fast growing polish automobile service
• https://wrc.net.pl - biggest racing site in Poland
• https://liberte.pl - selection of best articles from around the world

If you are using SasquatchWP contact me at [e-mail]