The purpose of this codebase is to create a new website for the charity, Wellington Night Shelter. The website uses the SilverStripe CMS as it's base.
SilverStripe Version used : SS4
The installation process only needs to be performed once when cloning this repository to a local machine.
# Checkout the repo
git clone [email protected]:silverstripeltd/project-skeleton.git <yourproject> -o skeleton
# Change directory to your project
cd <yourproject>
# replace the remote origin with your own
git remote remove skeleton
git remote add origin git://[email protected]/your/project.git
After cloning the project down, there is a set of commands needed to be exceuted in order to view the website/CMS locally. There are two methods of setting up the project locally.
NOTE : Run all commands in root directory of project.
Run the following command to setup the project with the makefile.
make init
Run the following commands to setup up the project manually.
# Run composer
composer install
# install yarn dependencies
yarn
# compile your CSS. This is empty initially
yarn dev
# create a .env file from the template
cp .env.example .env
# run a dev/build
vendor/bin/sake dev/build flush=1
# push to master
git push origin master
Project teams should run their website consistently, in order to help each other and avoid confusion by differences in configuration. SilverStripe Ltd. prefers Vagrant. Read the "Vagrant" Confluence page for setup and usage details.
yarninstall dependenciesyarn devbuilds dev js and scssyarn watchsame asyarn devbut watches for changesyarn productionminifies production filesyarn prodalias foryarn productionyarn lintlints your codeyarn hotunsupported hot module reloading