Skip to content

alpody/zircleUI

Β 
Β 

A frontend library to develop zoomable user interfaces.

npm Build Status downloads

Like it? Get involved, fork it or leave a star.

πŸ’₯ This is the dev branch of zircle-ui

npm install zircle@1.4.0-rc.1

Switch to master branch for latest estable release and documentation

Contributing

Many things could be improved and enriched with you collaboration no matter if you are a developer or not. Here you will find some guidelines for inspiration.

Stay updated

This is a dev branch, to be updated about what is being doing you can see the CHANGELOG and read the issues.

Development Setup

You will need Node.js version 8+ installed.

Open a terminal and type:

git clone https://github.com/zircleui/zircleui.git

After cloning the repository, execute:

npm install

To work with the dev branch, run:

git checkout dev

Commonly used NPM scripts

# start demo app npm run serve # to check and fix code npm run lint # run jest unit tests npm test # build zircle-ui library npm run build:zircle

Project Structure

. β”œβ”€β”€ dist β”œβ”€β”€ node_modules β”œβ”€β”€ public β”œβ”€β”€ src β”‚ β”œβ”€β”€ components β”‚ β”‚ └── child-components β”‚ β”œβ”€β”€ store β”‚ β”‚ └── modules β”‚ └── styles β”‚ └── sass └── tests └── unit 

License

MIT Licensed | Copyright Β© 2017 - present | Juan MartΓ­n Muda

About

πŸš€ zircle-ui is a frontend library to develop zoomable user interfaces.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Vue 49.0%
  • JavaScript 36.5%
  • CSS 14.1%
  • HTML 0.4%