Git Product home page Git Product logo

cozy-ui's Introduction

Cozy Ui

A clean Ui SDK designed to build Cozy apps.

If you plan to build a webapp to run on Cozy, you'll probably want to use a simple and elegant solution to build your interfaces without the mess of dealing with complex markup and CSS. Then Cozy Ui is here for you!

It relies on Stylus as preprocessor. You can add it as a library in your project to use it out-of-the-box.

Use

Cozy Ui is distributed as a Stylus plugin.

$ npm install --save-dev cozy-ui

Then simply add it to your plugins stack:

var stylus  = require('stylus')
  , cozyui = require('cozy-ui/lib/stylus');


function compile(str, path) {
return stylus(str)
  .set('filename', path)
  .set('compress', true)
  .use(cozyui());
}

With Brunch, you can declare directly your plugin in your brunch-config file:

plugins:
      stylus:
          plugins: [
              'cozy-ui/lib/stylus'
          ]

NOTE: Cozy Ui use Normalize.css by Nicolas Gallagher as a reset styles process. The CSS file is embedded directly by the Cozy Ui Stylus plugin, using the stylus include css statement to inline the CSS in the output instead of using a native CSS @import.

Then, you just need to add a @import 'cozy-ui' statement at top of your main stylus file.

Development

If you want to collaborate on Cozy Ui, you can use the demo app as a sandbox. Read the demo/README.md file for more informations on how to develop Cozy Ui.

License

Cozy Ui is developed by Cozy Cloud and distributed under the AGPL-3.0 license.

What is Cozy?

Cozy Logo

Cozy is a platform that brings all your web services in the same private space. With it, your web apps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one profiles you.

Community

You can reach the Cozy Community by:

cozy-ui's People

Contributors

kelukelu avatar m4dz avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.