Repository files navigation

NOTE: The library isn't complete yet

Slup was created by our desire for a performing UI framework following strictlyMaterial Design guidelines. It packs lightweight components, based on the blazing-fast React-like libraryInferno and our own styling method inspired by the well known styled-component, but rewritten in a smaller and lightweight fashion. The speed and small size of our packages provides some of the most gorgeous components in the design history with a lightweight and performant approach, perfect for your next PWA or web application.

Plus we've also got an amazing support provided byTypescript(the most lovedcompile-to-javascript language from the community)!

• High Performance
• Meticulousness
• Beautiful and well commented(understandable) code
• Be as indipendent from other libraries as possible
• Enhance compatibility with other frameworks like (p)react [NOT YET]
• Small size and small footprint

Slup is divided inpackages: each package represents a correspondingMaterial Design component, this means that each package can be found at@slup/<package> and installed separately improving bothsize and speed of your final bundle.Here's how:

Any slup package can be installed whitNPM as follows:

npm i -s @slup/<package>

NOTE: This process requires you to have installedyarn globally.

• To kick things off, clone the demo and enter that directory:

git clone https://github.com/slupjs/slup&&cd slup

• Install packages and run the demo:

yarn# Install the dependencies and build all the packagescd packages/Site# Go into the demo's site folderyarn compile:build# Build the javascritp SSR and clientyarn start# Start the demo server

NOTE: This process requires you to have installedyarn globally.

• To kick things off, clone the demo and enter that directory:

git clone https://github.com/slupjs/slup&&cd slup

• Install packages:

yarn# Install the dependencies and build all the packages

• Then move onto the demo's folder and start the watcher and the server:

cd packages/Site# Go into the demo's site folder# In a first terminal:yarn compile:watch# Bundle the application watching for changes# In a second terminal:yarn start# Start the demo server

Now feel free to make your changes and create newPRs 🎉

This project is licensed under the MIT License

• LucaT
• Gejsi