Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 3.29 KB

README.md

File metadata and controls

54 lines (36 loc) · 3.29 KB
Raw

GitHub tag GitHub issues GitHub PRs GitHub GitHub commit activity the past week, 4 weeks, year

Biotope is a framework which enables you to develop scalabale, platform-agnostic frontend component ecosystems

Definition Ecosystem vs. Ecosystem Framework:

  • A component ecosystem is a pool of components which can be used in any combination to build your websites or web applications user interface. The same components can be used in 1-n projects.

  • An ecosystem framework helps you building such an ecosystem and makes sure all components play well with each other, you get an overview over all components in the pooland information how to use them.

It helps developers to:

  • Build your UI components once and use them together with vanilla javascript or the js framework of your choice, in single page applications as well as in traditional server side rendered cms projects.
  • Keep focus on developing components, the architecture and dev environment is provided by Biotope.
  • Easy start, love to use it.
  • Build projects and design system styleguides with a single code source.
  • Easily ensure high quality standards for the whole library even when developed by multiple suppliers.
  • Make it easy to work with a team of many developers, all providing components to the library.
  • Create your own ui library to choose from in your projects.

It helps companies to:

  • Create a UI component library which can be maintained in a central place.
  • Versioning enables you to use all ui-components independently in different projects.
  • Ensure a consistent UI across all your projects.
  • Let multiple partners contribute to the ui library without compatiblity & quality issues. Bring their design system to live. Real usable code, no dummy html components in a seperate styleguide tool.
  • Doesnt matter how big the component library gets. Projects only use components they need. So performance stays high.
  • Maintain and extend the ui library over years to avoid getting out-of-date and having to start from scratch again.

It helps designers to:

  • Showcase their design systems in an always up to date living styleguide.
  • Have a single point of truth for the components available how they work and how they look.

Developing Biotope

  • We keep focus on our vision.
  • Our goal is to ensure things are interoperable between Biotope instances, beside that Biotope should be as flexible as possible.
  • Instead of one monolythic framework we try to split up Biotope in lightweight services each with a dedicated goal.

Installation

You can install the biotope boilerplate with it's cli using npx: npx @biotope/cli init <your-project-name> then change directories with to ./<your-project-name>

Or cloning this repo and run npm install

Documentation

You can find the documentation here.

In order to contribute to the documentation you have to start a local server in ./docs, then start editing the files in docs.