Giter Club home page Giter Club logo

surfplot-ui's Introduction

SurfPlot UI

A simple UI for visualizing mathematical surfaces

Image

This app is under development. The end goal is to basically create a modern, javascript-based version of Calc Plot 3D.

Accessing the UI

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:

  1. Download the ZIP of the repository. Unzip it in a place you can find it.
  2. Open your terminal/command prompt and navigate to the unzipped folder.
  3. Run these commands:
npm install
npm run build:desktop
npm run desktop

Scripts

  • start: Run a localhost and launch the development version of the app
  • build: Build the app into static files
  • build:desktop: Build the desktop version. Required before running desktop task.
  • desktop: Launch the desktop app, powered by electron
  • lint: Lint with eslint and stylelint
  • lint:fix: Lint and auto-fix anything that eslint can auto-fix (e.g. indentation)
  • test: Run all tests
  • precommit: Lints, tests, and builds to make sure everything is working.

Contributing

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.

surfplot-ui's People

Contributors

ericyd avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.