NMBS website pattern library
Get started
Checkout the project and install the dependencies with node or yarn:
$ yarn # or npm i
Then start up the development server and docs watcher
$ npm run dev
$ npm run docs
Development and deployment
Development is done on the develop branch.
The test branch is for experimental changes and corresponds to the staging environment at http://nmbs-redesign-website.staging.famous.be/library/.
All changes should be reflected in the changelog, divided into different categories as the previous changelog entries will point out. A change is marked as [BREAKING] towards the developers at NMBS/YPTO as soon as an action on their side is required. This mostly involves a markup change.
When a sprint is completed, it should be deployed to production.
Deploy to staging
Checkout the test branch, merge your changes into this branch. Then push the changes to the repo:
$ git checkout test
$ git merge develop
Deploy to production
Make sure your develop branch is fully commited and pushed and that the new version number is correct. Merge the ypto branch if needed.
$ git checkout master
$ git merge develop
Once merged push the master branch to production.
$ git add . && git commit -m 'pages merge'
$ npm run build-push-production
http://nmbs-redesign-website.production.famous.be/library/ Try testing the newly deployed version on production. Click some links, validate some components. This is the final check before you are going to push the library to npm.
As a safety check see the contents of public/.htaccess. The AuthUserFile should point to the production website!
$ npm run dist-push-production # push a new version to npmjs
Done.
Prepare the develop branch again for the next version (bump it in package.json), prep the changelog. Now you are good to go.