Skip to content

simplajs/components

Repository files navigation

Simpla

This is a monorepo of all of Simpla's official content components

Component Version
simpla-text
simpla-img
simpla-article
simpla-video
simpla-link
simpla-collection
simpla-admin

A what?

A monorepo, a single git repository that contains several packages. Each component (eg: simpla-text, simpla-img) is a separate NPM package under components/.

The monorepo approach makes maintaining large modular projects like Simpla much easier, and is followed by other successful ecosystems like Babel and React.

We use lerna to manage it.

Documentation

All components have their own documentation, demos, and API references in their folder under components, which in turn is listed on webcomponents.org. You can find them in the simpla-elements collection there.

Issues

Use this format when filing a Github issue for a component:

[component-name] Message

For example: [simpla-text] Something is broken

Contributing

There are lots of ways you can help push the Simpla project forward:

  • Reporting bugs. If you find a bug please report it! Open an issue against this repository for problems with any of the components, or the simplajs/simpla repo for problems with the core library.

  • Submitting Pull Requests. We ❤️ PRs! Your PR should address an existing issue or have been discussed previously to ensure it gets merged.

  • Publishing new components Simpla is a community driven project, and the best way you can contribute is to build your own content components! If you'd like to suggest your component to be added to this official collection, submit a PR for us to review. The ecosystem is built on Web Components, but there's no reason you couldn't use Simpla in a component environment of your choice (React, etc).

Read the Contributing guidelines for more information.


MIT © 2017