Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pretagov/nsw-design-system-plone6-kit


https://github.com/pretagov/nsw-design-system-plone6-kit

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README 

        
# NSW Design System Plone 6 starter kit



The [NSW Design System Plone 6 starter kit](https://digitalnsw.pretagov.com.au/) is an all-in-one solution to quickly get you started with a fully [NSW Gov Branding complaint](https://www.nsw.gov.au/branding/nsw-government-brand-framework)

site using the latest v3 version of the [NSW Design System](https://github.com/digitalnsw/nsw-design-system) and the flexibility and security of [Plone 6](https://plone.org/what-is-plone/plone/plone-6).



[Plone 6 NSW Design System Demo](https://digitalnsw.pretagov.com.au/).



## [Plone 6](https://plone.org/what-is-plone/plone/plone-6) is build for...



### Design Systems



- The [Volto Component based editor](https://plone.org/what-is-plone/plone/plone-6) let's you add any design system components WYSIWYG

- Simple intuitive modern UI means no editor training

- Design system guidance built in so compliance is assured

- Multi-column content that will automatically adapt to any device.

- [Try the Plone 6 Editor now](https://6.demo.plone.org/).



### Content governance



- Built with large organisations in mind with groups, delegation, fine grained permissions and customisable workflows

- Draft support let's you review changes to existing content before it goes live while preserving history

- Tagging, related items, faceted navigation let you organise content without coding

- No code Content rules, content types and layouts help enforce your content policies 

- Multilingual builtin



### Security



- Plone is trusted by CIA, FBI and Governments worldwide 

- [Plone's Security track record](https://plone.org/security) is over 20years and no major known security breaches

- Built on Python and No-SQL, a secure base with an excellent security track record

- Password strength, attempt lockouts, SSO and MFA available via plugins



### Speed



- Fast page loads with React based rendering means both search engines and users find information more quickly 

- “For every extra second it takes your site to load, conversion rates drop by an average of 4.42% (Portent, 2019)”

- Create content quicker with The [Volto Component based editor](https://plone.org/what-is-plone/plone/plone-6)



### Search

- Best-in-class relevant results using ElasticSearch

- Custom WYSIWYG search/listing page builder with DnD filters

- Automatic keyword highlighting in results

- Finds results in PDF, Word and other document formats uploaded to your site

- Suggested search terms to improve results 



### Developers



- Modern React with a mature decoupled CMS makes adding custom functionality fast and cost effective

- No code content types, content rules, forms, workflow reduce coding required to zero means you can save developer budget and get services up quicker



### Openness



- No single company who can cancel your IT investment with a single decision. Plone is a true cooperative.

- No hidden paid features. Enterprise grade search with custom search page builders, form builders, SEO optimisation, Workflow... all free. 

- Large community of integrators and an [ecosystem of plugins](https://plone.org/download/add-ons) available for free



## Why upgrade from Plone 5



### For the latest in Security Protection



Includes [security patch support for 2 major versions](https://plone.org/security/hotfixes/) and replacing unsupported Python 2.7 with Python 3.10 makes maintaining Plone 6 solutions easy. As a decoupled CMS, Plone 6 has best in class protection against DDOS attacks and continues to beat other CMS such as Drupal in terms of security.



Modern docker based deployment makes security and maintenance simpler.



### For the best in breed editing experience



The [Volto Component based editor](https://plone.org/what-is-plone/plone/plone-6) makes for a snappy intuitive content creation process.



## Why use the NSW Design System v3



A NSW government agency can comply to the NSW Government Branding with using the Design system 

but doing so provides many benefits

### Quicker Branding Compliance



Using a tool-kit like the [NSW Design System Plone 6 starter kit](https://digitalnsw.pretagov.com.au/) is one of the fastest ways to comply to the [NSW Gov Branding guidelines](https://www.nsw.gov.au/branding/nsw-government-brand-framework)



### Accessibility at WCAG 2.1 AA



Good implementations of the [NSW Design System](https://github.com/digitalnsw/nsw-design-system) will inherit [WCAG 2.1 AA Compliance](https://www.digital.nsw.gov.au/delivery/accessibility-and-inclusivity/accessibility-resources).



### Components at your finger tips, Masterbrand to Independent



The NSW Design System has been battle tested and refined to only give ways to express many different kinds of 

information but to express it well.



From Masterbrand to full Independent NSW Gov entity, using the NSW Gov Design System your users benefit from consistent and well designed forms and visual components. [NSW Design System Plone 6 starter kit](https://digitalnsw.pretagov.com.au/) has full support for Independent, co-brand and Endorsed in addition to Masterbrand sites.



## Support & Contributing



For more information on Plone, visit [plone.org](https://plone.org/) or reach out to the [Plone community](https://plone.org/community).



Feel free to open a [GitHub issue](https://github.com/pretagov/nsw-design-system-plone6-kit/issues) for any bug reports, feature requests or question about hosting. We welcome any and all community contributions and feedback! A contributing guide is in-progress, but highly encourage you to open an issue or get in touch. Support for hosting can be found by [our contributors](#contributors).



## Supported features



### Completed



- [Accordion](https://digitalnsw.pretagov.com.au/demo-pages/accordion)

- [Breadcrumbs](https://digitalnsw.pretagov.com.au/demo-pages)

- [Callout](https://digitalnsw.pretagov.com.au/demo-pages/callout)

- [Cards](https://digitalnsw.pretagov.com.au/demo-pages/cards)

- [Content blocks](https://digitalnsw.pretagov.com.au/demo-pages/content-blocks)

- [Filters](https://digitalnsw.pretagov.com.au/demo-pages/)

- [Footer](https://digitalnsw.pretagov.com.au/demo-pages/)

- [Header](https://digitalnsw.pretagov.com.au/demo-pages/)

- [Hero banner](https://digitalnsw.pretagov.com.au/demo-pages/hero-banner)

- [Images](https://digitalnsw.pretagov.com.au/demo-pages/images)

- [In-page alert](https://digitalnsw.pretagov.com.au/demo-pages/notifications)

- [In-page navigation](https://digitalnsw.pretagov.com.au/demo-pages/in-page-navigation)

- [List items](https://digitalnsw.pretagov.com.au/demo-pages/list-items)

- [Link list](https://digitalnsw.pretagov.com.au/demo-pages/link-list)

- [Main navigation](https://digitalnsw.pretagov.com.au/demo-pages)

- [Masthead](https://digitalnsw.pretagov.com.au/demo-pages)

- [Results bar](https://digitalnsw.pretagov.com.au/demo-pages/)

- [Search](https://digitalnsw.pretagov.com.au/demo-pages/search)

- [Sections](https://digitalnsw.pretagov.com.au/demo-pages/sections)

- [Videos](https://digitalnsw.pretagov.com.au/demo-pages/videos)



### In progress



- Buttons

- Dialog

- Global alert

- Hero search

- Pagination

- Progress Indicator

- Side navigation

- Step

- Tables

- Tabs

- Tags



## Getting started



The starter kit is formed of two parts a REST API backend and a React frontend. See the corresponding sections below for more details.



To get started with the starter kit, [view the demo](https://digitalnsw.pretagov.com.au/) or download the starter kit and run `make start` to try it locally.



To get started, ensure that the following dependencies are installed:



- [`yarn`](https://yarnpkg.com/getting-started/install)

- [`docker`](https://www.docker.com/)

- [`python`](https://www.python.org/)



### Create a site



1. Run `make start` to bootstrap and start both the backend and frontend.

2. Visit `localhost:8080` and create a site with an `id` of `Plone` (default). The default username and password are `admin`.

3. Visit `localhost:3000` to view your new site!



## Frontend



The starter kit frontend is made of two parts: [volto](https://plone.org/what-is-plone/volto) and the [NSW Design System addon](https://github.com/pretagov/nsw-design-system-plone6).



### Versions



The frontend was created using the latest volto version at the time of writing, [16.0.0-alpha.22](https://github.com/plone/volto/releases/tag/16.0.0-alpha.22). The frontend was bootstrapped with the Plone6 yeoman generator. See  for more info on created your own frontend.



## Backend



- Currently using Plone 6.0.0b1

- Using [buildout](https://www.buildout.org/en/latest/) to create a backend. See [Install a Plone backend locally without Docker](https://6.dev-docs.plone.org/volto/configuration/backend.html?highlight=buildout#install-a-plone-backend-locally-without-docker) in the Plone manual for more information on how this works.

- Is using [mr.developer](https://pypi.org/project/mr.developer/) to install some addons with git. Development sections are marked in the [buildout config file, `buildout.cfg`](backend/bin/Activate.ps1backend/buildout.cfg).



## Contributors



### PretaGov



PretaGov provide powerful content management systems, intranets, file sharing and collaboration solutions. Having worked with hundreds of public and private sector companies across Australia, PretaGov takes pride in offering strong security, privacy and accessibility compliance in all it's hosting and customisation services. PretaGov can be found on the [buy.nsw service panel](https://suppliers.buy.nsw.gov.au/supplier/profile/637) and more information about their products can be found on the [PretaGov website](https://www.pretagov.com.au/products).