It's non-opinionated and doesn't expect you to write your markup or code in any particular way.
An Astrum pattern library comprises of components organised into groups. A component comprises of a rendered sample of a particular element along with a code sample and a (optional) description for the components usage. A group can also have an (optional) description and is used for organisational purposes. You also have the option to add pages of content, for example an introduction page and/or coding guidelines specific to your project.
Originally Astrum was just going to be an internal tool to scratch our own itch in terms of providing a pattern library solution for our clients, however we decided to release it as an open source project under MIT license, for others to use for their teams and clients.
After using several pattern library solutions in the past, none of them has hit the nail on the head the way Astrum has, no need to duplicate code on third-party applications or waste time maintaining a separate project. It just works!
We had a number of goals that we wanted Astrum to achieve:
- We wanted it to be easy to include in a project. Astrum is an npm package which can be installed with a single command.
- We wanted it to be customisable. Astrum has simple theming features so that it can be branded to its companion project.
- We wanted it to be simple to add components/objects to the library. Astrum comes bundled with a command-line tool that allows you to easily manage components and groups with helpful feedback.
- We wanted it to be easy to update as we add new features. We‘ll continue working on Astrum and we’re aiming to ensure that new features are non-breaking additions to the platform. This means you’ll be able to update Astrum in existing projects with a single command and take advantage of these features as they become available.
- We didn’t want to have to worry about compiling assets. Astrum uses your parent projects assets to do its thing.
Since it’s release Astrum has received over 1000 stars on Github, has a community of contributors helping to improve Astrum and has been used by teams all over the world.