Sets of material design components built with web technologies

NOTE: The library isn't complete yet

Slup was created by our desire for a performing UI framework following strictly Material Design guidelines. It packs lightweight components, based on the blazing-fast React-like library Inferno 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 by Typescript(the most loved compile-to-javascript language from the community)!

Philosophy

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

Getting Started

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

Installation

Any slup package can be installed whit NPM as follows:

npm i -s @slup/<package>

Running the demo

NOTE: This process requires you to have installed yarn 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 packages
cd packages/Site # Go into the demo's site folder
yarn compile:build # Build the javascritp SSR and client
yarn start # Start the demo server

Development setup

NOTE: This process requires you to have installed yarn 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 new [PRs](https://github.com/Gejsi/Material/pulls) 🎉

## License

This project is licensed under the MIT License

## Authors

* LucaT
* Gejsi

slupjs / slup

readme