Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/CindyJS/CindyJS

A JavaScript framework for interactive (mathematical) content.
https://github.com/CindyJS/CindyJS

geometry javascript mathematics

Last synced: about 1 month ago
JSON representation

A JavaScript framework for interactive (mathematical) content.

Lists

README 

        
# CindyJS



**CindyJS is a framework to create interactive

(mathematical) content for the web.**



It aims to be compatible with [Cinderella](http://cinderella.de/),

providing an interpreter for the scripting language CindyScript

as well as a set of geometric operations which can be used to describe

constructions.

Together, these components make it very easy to visualize various

concepts, from geometry in particular and mathematics in general,

but also from various other fields.



See also our [project page](https://cindyjs.org).



## Examples



Examples on the web can be seen [here](https://cindyjs.org/gallery/main/).



There is also [an `examples` directory](https://github.com/CindyJS/CindyJS/tree/master/examples)

inside the repository, demonstrating individual functions and operations.



Developers can run these examples from their local development copy.

Some examples may require a webserver-like environment to avoid

triggering browser security measures associated with local files.

To do so, one can run node_modules/.bin/st -l -nc

in the root of the development tree, and then visit

[the local copy of the examples directory](http://127.0.0.1:1337/examples/).



## Building



If you have `npm` installed, running `npm install`

in the top level source directory should just work.



If you lack a compatible setup of `npm` and `node`,

running `make build=release` in the top level source directory should

be able to get a suitable setup installed inside the project directory tree.

In general, all required third-party tools should be automatically downloaded

and installed inside the project directory tree.

One exception is a Java Runtime Environment, which has to be installed before

(because users have to manually accept the terms and conditions before

being allowed to download a JRE).



If `npm` resp. `make` terminated successfully, then `build/js` will contain

the artefacts which you'd likely want to include in your web site.

If you are building from an official commit, then `make build=release deploy`

will create `build/deploy` which is even better suited to be put on a web server,

since it references the commit at GitHub which may help diagnose problems.



### Building on Windows



The description above uses `make` mostly for convenience.

Pretty much all the commands are in fact passed on to

a JavaScript-based build system contained in the `make` directory.

If you don't have `make` available on Windows,

you can call `node make` instead.

So a standard release build would be `node make build=release`.



Note that you should have the following software installed:



-   A recent Java Runtime Environment (JRE)

-   Node.js with the `node` command added to the PATH

-   Git for Windows with the `git` command usable from the Windows Command Prompt



## Contributing



When you work on the code base the simple `make` or `node make`

will give you a build which is fast to compile and easy to debug.

In contrast to this, `node make build=release` will

perform additional compilation steps like running the Closure Compiler.

It may issue more warnings, which in turn might be useful when developing.

You should make sure that your code works in both build modes.



If you are confident that your work is done, call `make alltests`

after you did `git add` to stage your changes.

That will ensure that your modifications pass all kinds of tests.

The same tests will be run automatically on pull requests.

Once your modifications satisfy your expectations, pass these tests

and are accompanied by a suitable test case or demonstrating example

(where appropriate), you may file a pull request for your changes.



## Documentation



[The CindyJS API documentation](https://github.com/CindyJS/CindyJS/blob/master/ref/createCindy.md)

describes how to create a widget on an HTML page using this framework.



Other documentation in [the `ref` directory](https://github.com/CindyJS/CindyJS/tree/master/ref) describes

large portions of the CindyScript programming language. This

documentation, however, started as a copy of

[the corresponding Cinderella documentation](http://doc.cinderella.de/tiki-index.php?page=CindyScript). It

is currently meant as a goal of what functionality _should_ be

supported, while actual support might still be lagging behind. If there

is a particular feature you'd need for your work, don't hesitate to

[file a feature request](https://github.com/CindyJS/CindyJS/issues) for it.



## License



CindyJS is licensed under the

[Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0.html).