Lyra (UNDER CONSTRUCTION)

INFO: This package is not ready yet. Version 2.0.0 will be the first stable release.

This is a design system intended to make the development process for designing and releasing components beautiful and easy.

What does Lyra do?

Here is a quick list of some of the items Lyra does:

• Establish a new project with pre-configured defaults that should be perfect for most projects. This includes all necessary settings for React, Typescript, Mocha and deltav.

• Provide development tools so you can develop quickly and with ease

• Provide flexible and powerful release tools. Are you deploying a library? Is the library bundled or piecewise? Do you want type definitions included for your library? Do you want to include a static web server? Does your project include a front AND backend? Lyra addresses ALL of this and more, saving you a LOT of time not worrying about dev ops for your team.

• Provide a Custom Component viewer to present your developed components in a beautiful API documentation that has powerful tools for experiencing your library.

• Provides set up for a powerful webgl visualization framework to make it easier to create and craft large scale visualizations.

Using Lyra

Getting started with lyra is incredibly easy and made to work with npx.

Create a new project

Lyra will build a project for you with everything you need pre-configured. Lyra also has some flexibility to allow you to

With npx you can start a node project and everything in an empty directory:

npx lyra install [optional path to directory]

With just npm, you need to have a node project set up in your target directory then:

npm i -DE lyra
./node_modules/.bin/lyra install

WARNING: Lyra will prompt you, asking if you want to use the lyra default configurations. It is highly recommended and essentially required to say 'Yes' in order to use Lyra. Only advanced users of the install procedure should say no.

Develop your project

After you have installed a new lyra project you can now begin writing your own code. The code for your library

Test your prject

Development for Lyra

The following is NOT for USING Lyra, but rather for developing features for Lyra.

Developing and Testing

npm run dev

WIP

Note this library is under development to get to first distribution. It is NOT a working product yet.

DOCS

TODO