Documentation | Changelog | Contributors | Contributing guidelines | Code of Conduct
sifrr is a set of tiny, customizable, independent libraries for creating modern and fast webapps using JavaScript.
This repository is a monorepo managed using yarn workspaces. This means there are multiple packages managed in this codebase, even though they are published to NPM as separate packages. They will always have same latest version and are released together.
Note that for 0.x releases of this library, the API is not considered stable yet and may break between minor releases. After 1.0, Semantic Versioning will be followed.
| Package | Description | NPM | Documentation | Tests |
|---|---|---|---|---|
| sifrr-dom | Small Library to build UIs with custom elements |  |
 |
OK |
| sifrr-template | ⚡ Fast HTML-JS Templating engine used in sifrr-dom |  |
|
OK |
| sifrr-fetch | Wrapper library for Browser fetch API can be used in node too |  |
|
OK |
| sifrr-route | Routing for sifrr-dom |  |
|
OK |
| sifrr-serviceworker | Service worker wrapper library |  |
|
OK |
| sifrr-storage | Browser persisted storage library (2kb alternate to localforage) |  |
|
OK |
sifrr-dom, sifrr-template, sifrr-fetch, sifrr-serviceworker, sifrr-storage can be used independently. sifrr-route is a sifrr-dom element, hence it should be used with sifrr-dom.
| Package | Description | NPM | Documentation | Tests |
|---|---|---|---|---|
| sifrr-api | Create normal/GraphQL APIs with same codebase |  |
|
OK |
| sifrr-cli | Sifrr cli for creating webapps using sifrr |  |
|
[WIP] |
| sifrr-seo | Server side pre-rendering using puppeteer with caching |  |
|
OK |
| sifrr-server | Fast HTTP + WebSockets server |  |
|
OK |
sifrr-api, sifrr-seo, sifrr-server can be used independently. sifrr-cli has functionalities which can be used with sequelize projects, sifrr-api projects and sifrr-dom projects.
All the packages can be used with node, es6 modules, and are compatible with bundler of your choice (rollup, webpack, browserify)
const SifrrDom = require('@sifrr/dom');import SifrrDom from '@sifrr/dom'; // default export
import { Element } from '@sifrr/dom'; // named exportFor eg.
<script src="https://unpkg.com/@sifrr/dom@{version}/dist/sifrr.dom.min.js"></script>
// for v0.0.3
<script src="https://unpkg.com/@sifrr/dom@0.0.3/dist/sifrr.dom.min.js"></script>
// this sets window.Sifrr.Dom as sifrr-dom, same for other packagesSifrr officially supports node v10, v12 (LTS), v13 (current). Other versions might work for some packages.
Sifrr browser packages officially supports these browser versions (for dist files):
| Browser | Version |
|---|---|
| Chrome | >= 55 |
| Android Chrome | >= 55 |
| Firefox | >= 63 |
| Android Firefox | >= 63 |
| Opera | >= 42 |
| Safari | >= 10.1 |
| Safari (iOS browsers) | >= 10.1 |
Individual libraries may support older versions too with polyfills listed in docs, or by bundling it with polyfills using babel etc.
Approximately amounts to ~90% of total worldwide browser usage.
To support mini browsers (opera mini, uc browser etc.), You can use sifrr-seo to provide server side rendering.
This project exists thanks to all the people who contribute. [Contribute].
Become a financial contributor and help us sustain our community. [Contribute]
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
Sifrr is MIT Licensed.
