A simple UI for visualizing mathematical surfaces
This app is under development. The end goal is to basically create a modern, javascript-based version of Calc Plot 3D.
The current version of the app can be found online at http://ericyd.github.io/surfplot-ui.
Alternatively, you can run an offline version of the app (powered by Electron) on your own computer. This might be more responsive in some cases.
To build and run the offline version, you will need Nodejs (version 4.x or higher) and Git*. Then run the following commands:
git clone https://github.com/ericyd/surfplot-ui.git
cd surfplot-ui
npm install
npm run build:desktop
npm run desktop
*If you don't have, or don't want to install, Git, you can use these alternative directions:
- Download the ZIP of the repository. Unzip it in a place you can find it.
- Open your terminal/command prompt and navigate to the unzipped folder.
- Run these commands:
npm install
npm run build:desktop
npm run desktop
start
: Run a localhost and launch the development version of the appbuild
: Build the app into static filesbuild:desktop
: Build the desktop version. Required before runningdesktop
task.desktop
: Launch the desktop app, powered by electronlint
: Lint with eslint and stylelintlint:fix
: Lint and auto-fix anything that eslint can auto-fix (e.g. indentation)test
: Run all testsprecommit
: Lints, tests, and builds to make sure everything is working.
Contributions are encouraged, though you might just want to build your own version since
there isn't really much to be gained by contributing to this repository.
If you decide to contribute, please run npm run precommit
before submitting a pull
request to make sure that your script passes all the linters and tests.