thebaronalex/zircleui

🚀 zircle-ui is a frontend library to develop zoomable user interfaces.

A frontend library to develop zoomable user interfaces.

Like it? Leave a star, it will help to attract more visitors and contributors.

💥 This is the dev branch of zircle-ui

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