Skip to content

seek-oss/sku

Repository files navigation

npm


sku


Front-end development toolkit, powered by Webpack, Babel, Vanilla Extract, CSS Modules, Less, ESLint, Prettier, Jest and Storybook.

Quickly get up and running with a zero-config development environment, or optionally add minimal config when needed. Designed for usage with braid-design-system, although this isn't a requirement.

This tool is heavily inspired by other work, most notably:

Warning

While this software is open source, its primary purpose is to improve consistency, cross-team collaboration and code quality at SEEK. As a result, it’s likely that this tool may not exactly suit your needs, or may be overkill for your use case. It may be worth considering alternatives such as Vite or Parcel.

Getting Started

Create a new project and start a local development environment:

$ npx sku init my-app
$ cd my-app
$ yarn start

By default, a new project's dependencies will be installed with the first supported package manager detected on your system. Package managers are detected in the following order: yarn -> pnpm -> npm. This can be overridden via the --packageManager flag:

$ pnpm dlx sku init --packageManager pnpm my-app
$ cd my-app
$ pnpm start

Contributing

Refer to CONTRIBUTING.md. If you're planning to change the public API, please open a new issue.

License

MIT License