Skip to content

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

License

Notifications You must be signed in to change notification settings

lucaperl/smoovy

 
 

Repository files navigation

smoovy

CircleCI Codecov contributions welcome License

Synopsis

smoovy is a collection of small and useful js packages preventing copy & paste. The goal is to use as few dependencies as possible to guarantee a small final bundle. Also to keep the code clean, small and simple.

Main packages

Name Version Size
 @smoovy/scroller Version  Size
 @smoovy/observer Version  Size
 @smoovy/tween Version  Size
 @smoovy/ticker Version  Size
 @smoovy/utils Version  Size

Getting started

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

npm install --save @smoovy/<package>

Roadmap 2019

  • 📦 Create @smoovy/parallax (parallax effect math)
  • 📦 Create @smoovy/timeline (timeline for tweens)
  • 📦 Create @smoovy/text-split (easy text splitting)
  • 💡 Improve tween demos
  • 💡 Improve documentation
  • 💡 Improve testing
  • 💡 Improve code coverage

Workflow

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

Every command related to a package will be executed from the root directory via scripty

Building a package

To ensure the best result, packages are created with rollup. The following formats are supported: cjs, umd and esm.

npm run build:package <name>

Testing a package

Packages will be tested with jest and puppeteer. The dist files will be used for testing.

npm run test:package <name>

Serving a package demo

The demo will be served and bundled with parcel. Every demo must have a index.html file. The source files will be used for the demo.

npm run serve:package <name> [<demo>, default]

Linting a package

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

npm run lint:package <name>

License

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

About

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

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 92.9%
  • HTML 4.1%
  • JavaScript 1.6%
  • CSS 1.3%
  • Shell 0.1%