@compossibru/compossibru
Build a composite UI easily
Last updated a year ago by maikay .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @compossibru/compossibru 
SYNC missed versions from official npm registry.

@compossibru/compossibru

npm latest version semantic-release

compossibru helps you to build a composite UI easily.


Composite UI?!

Use compossibru

How does it work?

compossibru is a wrapper around next.js.

How to install and configure?

Install it:

npm install @compossibru/compossibru

Add widgets:

npm install @compossibru/widget-twitter-widgets

Add scripts in your package.json:

{
  "scripts": {
    "start": "npx compossibru start",
    "build": "npx compossibru build"
  }
}

Add configuration to your .compossibrurc file:

Version: 1
Routes:
  Home:
    Route: /
    Layout: layouts/main.ejs
    Containers:
      left:
        - "@compossibru/widget-twitter-widgets":
            type: Timeline
            options:
              dataSource:
                sourceType: profile
                screenName: npmjs
              options:
                username: npmjs
                height: 400
      middle:
        - "@compossibru/widget-twitter-widgets":
            type: Timeline
            options:
              dataSource:
                sourceType: profile
                screenName: github
              options:
                username: github
                height: 400
      right:
        - "@compossibru/widget-twitter-widgets":
            type: Timeline
            options:
              dataSource:
                sourceType: profile
                screenName: internetofshit
              options:
                username: internetofshit
                height: 400

Add custom layouts to your layouts folder (e.g. main.ejs):

<div>
    <div>
        <%- left %>
    </div>
    <div>
        <%- middle %>
    </div>
    <div>
        <%- right %>
    </div>
</div>

The final project structure looks now the following:

.
├── layouts
│   ├── main.ejs   
├── .compossibrurc
├── package.json

Congrats. You are done. compossibru is configured!

To start:

npm start

Enter http://localhost:3000

How to write a widget?

tbd

Which features are still left?

License

MIT

Current Tags

  • 1.1.1                                ...           latest (a year ago)

2 Versions

  • 1.1.1                                ...           a year ago
  • 1.0.3                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 2
Last Day 0
Last Week 2
Last Month 1
Dependencies (9)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |