Skip to content

Commit c22cb35

Browse files
committed
add README.md into source
1 parent 72748da commit c22cb35

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

src/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# daVinci.js
2+
3+
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/528f21b212c34df8b2a3023cb0f33d02)](https://app.codacy.com/app/konne/daVinci.js?utm_source=github.com&utm_medium=referral&utm_content=q2g/daVinci.js&utm_campaign=badger)
4+
[![TravisCI](https://travis-ci.org/q2g/daVinci.js.svg?branch=master)](https://travis-ci.org/q2g/daVinci.js)
5+
[![npm version](https://badge.fury.io/js/davinci.js.svg)](https://www.npmjs.com/package/davinci.js)
6+
[![npm downloads](https://img.shields.io/npm/dt/davinci.js.svg)](https://www.npmjs.com/package/davinci.js)
7+
8+
davinci.js is a framework to build visual elments for the qlik sense plattform.
9+
10+
The most important design principal is that you can use the visual element easy
11+
as qlik extension in the qlik sense enterprise, but also to use it in own
12+
angular websites with just Enigma.JS and without the whole qlik.js stack.
13+
14+
The rest design principals:
15+
* accessibility, screenreader ready and keybord usage / shortcuts
16+
* ready for versioning, possibility to run different versions of the plugin or elements
17+
in one page
18+
* stay close to the qlik ux
19+
20+
The plan is in the end to get even angular 1.x and angular 4+ elements out
21+
of one codebase.
22+
23+
# Getting started
24+
25+
## Prerequisites
26+
27+
Before continuing, make sure that you have these tools installed:
28+
29+
Node.js >= 4.0
30+
Git bash
31+
Visual Studio 2017 with TS
32+
33+
And know of at least some these web technologies:
34+
35+
TypeScript
36+
Angular
37+
Promises
38+
39+
# Docu
40+
41+
[List of (Visual)-Elements](docs/elements.md)
42+
43+
[Architecture](docs/architecture.md)
44+
45+
# Usage
46+
47+
first start with https://github.com/q2g/q2g-ext-selector or any other published extension.
48+
49+
make a git subtree clone into your own extensions (see Docu)
50+
51+
... later we will add a npm packages

0 commit comments

Comments
 (0)