willybrauner / smoovy

A collection of small and useful js packages (smooth scrolling, router, parallax, utils, etc.) preventing copy & paste

smoovy

A collection of small and useful js packages for simple preventing copy & paste. The goal is to use as few dependencies as possible to guarantee a small final bundle.

Packages

Name	Version
@smoovy/composer
@smoovy/scroller
@smoovy/observer
@smoovy/parallax
@smoovy/tween
@smoovy/ticker
@smoovy/emitter
@smoovy/listener
@smoovy/router
@smoovy/webgl
@smoovy/utils

Getting started

Choose a package you want to install. It's as easy as that:

yarn add @smoovy/<package>

or

npm install --save @smoovy/<package>

Workflow

This is a simple monorepo consisting of some of the packages mentioned above.

Building a package

To ensure the best result, packages are created with esbuild and tsc.

yarn build --scope=<name>

Testing a package

Packages will be tested with vitest.

yarn test --scope=<name>

Some packages are still missing tests. These will be excluded from the code coverage completely.

Serving a package demo

The demo will be served and bundled with vite. Every demo must have a index.html file.

yarn dev --scope=<name>

Linting a package

The ESLinter is being used for linting packages. Everything except the src folder will be ignored.

yarn lint --scope=<name>

License

See the LICENSE file for license rights and limitations (MIT).