Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.68 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.68 KB

Build Status

Network Animations

This is a suite of network animations built using modern web technologies. View live at https://dabh.github.io/network_animations/.

Organization

Source code for the animations is located in the src directory. When built, the bundled output is placed into the dist directory.

The src directory is organized into several sub-directories. Components contains GUI components for the animations. Animations contains definitions of the animations that make up the suite.

Setup

The suite is built on modern web technologies (as of this writing), including Webpack and Typescript. To get started:

  1. Install Node.js
  2. Install yarn: npm install -g yarn
  3. Clone the repository
  4. Within the repository, run yarn to install dependencies

The animations can now be built and viewed (see the next section).

Testing

From the root directory, you can run yarn start to start a local development server on http://localhost:8080/network_animations/. Point your browser to that address to view the animations running locally. yarn build can also be run to see if the packaging is successful. Continuous integration is enabled for the master branch of this repository, and it currently just runs yarn build to make sure everything compiles.

License

Please see the included LICENSE.md and COPYING.