https://github.com/syntro-opensource/silverstripe-ssto
The SilverStripe Framework Installer for Syntro Projects
https://github.com/syntro-opensource/silverstripe-ssto
recipe silverstripe silverstripe-ssto themed
Last synced: 4 months ago
JSON representation
The SilverStripe Framework Installer for Syntro Projects
- Host: GitHub
- URL: https://github.com/syntro-opensource/silverstripe-ssto
- Owner: syntro-opensource
- License: bsd-3-clause
- Created: 2020-08-31T11:41:58.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-10-20T12:47:26.000Z (8 months ago)
- Last Synced: 2025-10-20T13:10:02.219Z (8 months ago)
- Topics: recipe, silverstripe, silverstripe-ssto, themed
- Language: Scheme
- Homepage:
- Size: 5.57 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# Syntro Silverstripe SSTO 🌍 🚀 ✨
[](https://github.com/syntro-opensource/silverstripe-ssto/actions/workflows/tests.yml)
[](https://packagist.org/packages/syntro/ssto)
[](https://packagist.org/packages/syntro/ssto)
Syntro Silverstripe SSTO (from the abbreviation for **S**ingle-**s**tage-**t**o-**o**rbit)
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](https://github.com/syntro-opensource/ssdev) for more info on our devenv.)*
```
npx ssdev init -r syntro/ssto:^2 projectname
```
> After installation, consult the [checklist](docs/checklist.md) 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](docs/theming.md)
## 🎭 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](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
(for big teams) or the [Git Feature Branch Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/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](CHANGELOG.md)
* [Contributing guide](CONTRIBUTING.md)
* [License](LICENSE.md)