Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 1.22 KB

dev-environment.md

File metadata and controls

51 lines (40 loc) · 1.22 KB

Run dev environment

Install devDependencies

npm install

Run webpack dev server

npm run start:dev

In the console you should see something like: "Project is running at http://localhost:9090/" call the url in the browser.

Run test

npm run test
// or
npm run test:watch

Run linting

npm run lint

Build javascript and css files

npm run build

Project structure

Folder Description
dist minified css and js version for implementing in script tag
docs md documentation files
public content-base for webpack dev server, contains some circliful examples
src all code for the library
style scss styling files for circles
test unit and dom tests, coming soon...

src folder

Folder Description
base-class basic classes to centralize main features
circle-type some default circles, you can add there your own
helper svg and object helper
interface typescript interfaces for validation