syntro/ssto

The SilverStripe Framework Installer for Syntro Projects

2.4.2 2023-04-29 14:16 UTC

Requires

• php: >=7.4.0
• silverstripe/login-forms: 4.9.0
• silverstripe/recipe-cms: 4.13.0
• silverstripe/recipe-plugin: ^1.2
• syntro/recipe-elemental-bootstrap: 1.1.2
• syntro/silvershare: 1.0.4
• syntro/silverstripe-seo: 2.2.1
• wilr/silverstripe-googlesitemaps: 2.2.1

Requires (Dev)

• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: *
• syntro/silverstripe-phpstan: ^1.0

BSD-3-Clause

• cms
• silverstripe
• recipe

README

Syntro Silverstripe SSTO (from the abbreviation for Single-stage-to-orbit) provides a prepackaged recipe for starting a new Silverstripe project from scratch. Featured are:

• bootstrap based styling
• webpack based build tooling
• elemental editor with some standard blocks to get you started

📯 Getting started

To get started, simply run: (see ssdev for more info on our devenv.)

npx ssdev init -r syntro/ssto:^2 projectname

After installation, consult the checklist to make the newly created project your own. Then, you should replace this part of the readme with a guide on how to clone the new project

🖥 Serving Silverstripe

To start the server via docker, run

npx ssdev serve

This will start a host and database container running your project. To stop it, run

npx ssdev down

🎨 Theming

-> Refer to the 📖 theming docs

🎭 Testing

By default, this recipe supplies PHPUnit, PHPCS and PHPStan for testing. you can run the tests by executing:

npx ssdev run -- vendor/bin/phpunit

npx ssdev run -- vendor/bin/phpstan analyse --memory-limit=1G -l4 -c phpstan.neon app/src/

npx ssdev run -- vendor/bin/phpcs app/
npx ssdev run -- vendor/bin/phpcbf app/

🆕 Commiting new Things

We recommend using the Gitflow Workflow (for big teams) or the Git Feature Branch Workflow (for small teams). When creating new PRs with features, use the "squash and merge" option and prefix the resulting commit with (it helps adding the prefix to the PR title):

• add: when something new is added
• fix: when something is fixed
• change: when something is changed
• deprecate: when something will be removed
• remove: when something was removed
• (Bump: for dependency updates)

Following this makes releasing easier and allows using an automatically generated changelog.

🚀 Releasing

After you have a deployable application / website, you can deploy it to a server. We recommend you follow these steps (which will incidentally also trigger the production deployment job):

1. Make sure all tests pass
2. Run npm run release --next="x.x.x"
3. Commit the changes as release/x.x.x and push them
4. Create a new release x.x.x on Github

➕ More Infos

Check out the following for more informations:

• Changelog
• Contributing guide
• License