Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.48 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.48 KB
Raw

AlgoriVA

A modular algorithm visualization software.

Installation

Github Links

You can always use the web app here

Build

$ git clone [email protected]:omeryagmurlu/TSA-Software.git algoriv
$ cd algoriv
$ yarn
$ yarn run watch:browser

Packaging

$ yarn run package-linux
$ yarn run package-win
$ yarn run package-all

Usage

See docs/usage.md

File Structure and Grammar

- app
	- containers
	- features
	- views
	- components
	- styles
	- index.js
  • Index refers to a container.
  • Containers can only import features, data, another containers and views.
  • Views can only import components and styles.
    • For routing, containers, or another views must supply the needed data.

props.app props, and props.app.settings

app is a common prop that every container and view has access to. It is used to trigger or retrive app specific actions. Components are prohibited to have access to it.

app.settings is the state saver. Only containers and views have access to it. Components may only have access to it's visual-cache subset for having persistent ui state.