kickstartDS mono-repository, containing all packages but config related ones and the content component module
OTHER License
kickstartDS is an Open Source Design System starter and UI toolkit for building up your very own Design System. This in turn enables you, and your team, to build brand-compliant websites and apps super efficiently. All while using core web technologies — HTML, CSS, and JavaScript — and best practices.
We started work on extensive documentation around kickstartDS, the best practices employed, ways of creating components and integrations available. We will continuously expand on this, so please let us know what you're missing!
We have the following categories in our docs:
This is our main guide, where you'll create a complete Design System from scratch... based on kickstartDS.
Start here: https://www.kickstartds.com/docs/guides/create/
Or jump directly into a specific section of it:
We have a dedicated CLI, you can find it over here: https://github.com/kickstartDS/kickstartDS-cli
Our CLI helps deliver everyday tasks faster, and with less errors! Create and compile token, work with JSON Schema and other parts of kickstartDS.
Learn more about our CLI in our docs: https://www.kickstartds.com/docs/intro/cli
No modern technical solutions exists in a vacuum. Having a lively ecosystem enables broader and quicker adoption, while sharing knowledge and common learnings with a wider, organic community.
This is why we're also always actively trying to add building blocks to that ecosystem ourselves, while listening closely to which problems people are actually trying to solve.
We already have the following in place:
Learn more about generators on our integration page: https://www.kickstartds.com/integrations/
Or read our documentation about tooling and integrations: https://www.kickstartds.com/docs/integration/
We try to have a healthy, friendly and active community. Although it's still quite small, this also enables us to respond to requests in a very hands-on fashion.
Feel free to join us on Discord!
If that's not your cup of tea, you can also reach out to us:
This project is managed by lerna. Each module is an independent lerna package. Install module-specific dependencies only via lerna add
(see "Install npm dependencies" section)!
node >= v14 – if you have nvm installed, you can just run nvm use
to select the right node version.
yarn classic
npm install -g lerna commitizen
If you cannot or don't want to install global packages, you can use yarn. E.g. instead of git cz
, you can also call yarn git-cz
.
yarn
- installs npm dependencies for all frontend modulesyarn build
– builds the pattern libraryyarn storybook start
- starts a storybook with all componentsyarn lint
– checks sass- & js-files against potential errorsyarn list
– lists all lerna packagesReleases are mangaged by Auto.
All modules are placed in the pacakges/components directory. They are individual npm packages mangaged by yarn workspaces.
Don't install module dependencies manually, let yarn do the job!
E.g. to install "package-xy" in module "news", run yarn workspace news add package-xy
in the projects root directory.
This project uses commitizen. So in order to commit your changes, run git cz
(or yarn git-cz
if commitizen is not installed globally) instead of git commit
. commitizen will then ask you a few questions about the change:
This convention is based loosely on the angular commit message guidlines and ensures constistent commit messages, so they can be automatically converted into a changelog.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as below, without any additional terms or conditions.
© Copyright 2022 Jonas Ulrich, kickstartDS by ruhmesmeile GmbH [[email protected]].
This project is licensed under either of
at your option.
The SPDX license identifier for this project is MIT OR Apache-2.0
.