2019's New years resolution - Getting to **done** on Shoreditch!!
Hi all,
The Shoreditch project has been a monster… now in its 3rd year... and its time to get it to done!
Shoreditch was envisaged as both a theme layer on top of the existing CiviCRM markup, and also a new CSS style guide and theme based on the bootstrap framework. Both would look “the same” and hence allow us to migrate old screens to the new markup piece by piece without the users knowing the change was happening.
Shoreditch was designed to bridge from CiviCRM’s old markup to Boostrap to allow us to migrate to a bootstrap based HTML markup and associated standards, and to therefore allow anyone to create any themes in future.
We’re sad that Shoreditch has taken so long - it’s largely been funded internally by Compucorp allocating time and resource from the CiviHR project and also from several kind contributions from Amnesty and NDI along the way.
Unfortunately, however after many hours on the project we are still not complete and we wanted to reach out to the community to help us get finally over the line.
There has been a lot of feedback, and we are listening (and reading!) all of it. We want this to be great so we can all move CiviCRM forward. Shoreditch has amazing potential - see Mosaico or the new CiviCase with Shoreditch enabled: https://github.com/compucorp/uk.co.compucorp.civicase/tree/develop (see wip develop branch) and it would be amazing to really get this out to everyone.
There have been a lot of technical challenges and a lot of lessons learnt along the way, but we still believe that without Shoreditch it will be impossible for CiviCRM to move to a standardised markup - as otherwise we cannot have new and old screens living side by side.
As such we are reaching out to plan a series of Shoreditch targeted community remote sprints that we would like to plan for January 2019 to finally get Shoreditch over the line and finally take CiviCRM’s look and feel to the level it needs!
Getting to done on Shoreditch:
What is the stable version of Shoreditch (bootstrap):
- All CiviCRM core screens are styled in the Shoreditch style
- Styled default bootstrap components
- Provided full list of components for migration path
- Identified the custom components (or at least the process to vet them)
- All components (default and custom) accounted for in the style guide
Full list of components (all bootstrap default and customly written), that allows you to migrate all the existing core screens to bootstrap. Core components are the components provided by fresh installation of Latest CiviCRM v5.x without any additional extension installed.
Shoreditch launch blockers:
We've created this handy list:
https://docs.google.com/document/d/1tO3BhI06_SceVL8Vhj-P4Ud_6rh-wR71c9b0Br9wsvc/edit?usp=sharing
Its not that long... but its not that short either!
The plan!
We will arrange 3 x 2 week long “sprints” during January, Feb and March and we would love to put a team together of people who would be willing to contribute their time.
We will have a kickoff in early January to groom the tickets and to allocate these to the volunteers. In week 1 of each sprint we will have a series of short calls to discuss technical approaches to tickets and to finalise and agree how they should be solved. If anyone needs help setting up testing environments with backstop JS we’ll be taking everyone through the process.
Then in week 2 it’s time to write the code and members of the Compucorp team will be available to support anyone working on tickets via Mattermost. We’ll get the tickets QA’d / reviewed and then merged with a plan to do a release at the end of each month with the new improvements.
TLDR
If you would like to be a part of making Shoreditch happen then please add your name, contact email and availability to this spreadsheet:
https://docs.google.com/spreadsheets/d/1mkmlFb9IoGVGfWAb-LtIYQ4RKdLSbo95zpEr9wA6O_E/edit#gid=0
if you would be able to contribute your time.
Those who contribute 25h or more will have their organisational logos displayed prominently on the Shoreditch extension page, and will also be mentioned on any future blog posts or communications made about the project.
After the success of the sponsorship for the new Drupal 8 Webforms work we will be also running campaign to fund this project with co-sponsorship packages. So if you're interested in receiving this information as soon as it becomes available, please leave your details on the spreadsheet and we will send those over as soon as they are finalised.
It's been a long time coming... but looking forward to making 2019 the year Shoreditch finally arrives!