grid-apps-cmms/readme.md
2021-01-02 11:24:07 -05:00

75 lines
3.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/gridspace3d?locale.x=en_US)
Contributions in all forms (code, bug reports, community engagenment, cash money, etc) are warmly welcomed. They all go to the bottom line of making better apps.
[![Discord](https://img.shields.io/discord/688863523207774209)](https://discord.com/channels/688863523207774209/688863523211968535)
![GitHub](https://img.shields.io/github/license/GridSpace/grid-apps)
![Twitter Follow](https://img.shields.io/twitter/follow/grid_space_3d?label=follow&style=social)
### Hosted Apps
* [Grid.Space](https://grid.space) hosts [several live versions](https://grid.space/choose) of the code
* [Kiri:Moto](https://grid.space/kiri) -- A Unique, Multi-Modal, Browser-based Slicer for 3D printers, CNC mills and Laser cutters
* [Meta:Moto](https://grid.space/meta) -- A Recursive Block-based Modeler
### Live Versions
[![Website](https://img.shields.io/website?url=https%3A%2F%2Fgrid.space%2F)](https://grid.space/kiri/)
![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/GridSpace/grid-apps/rel-2.1)
![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/GridSpace/grid-apps/rel-2.2)
![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/GridSpace/grid-apps/rel-2.3)
![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/GridSpace/grid-apps/rel-2.4)
### Development Activity
![GitHub commit activity](https://img.shields.io/github/commit-activity/w/GridSpace/grid-apps)
![GitHub last commit](https://img.shields.io/github/last-commit/GridSpace/grid-apps)
![GitHub contributors](https://img.shields.io/github/contributors/GridSpace/grid-apps)
## Get Involved
* [Facebook Kiri:Moto Users Group](https://www.facebook.com/groups/kirimoto/)
* [YouTube Videos](https://www.youtube.com/c/gridspace)
* [Twitter Updates](https://twitter.com/grid_space_3d)
* [Discord Chat](https://discord.com/channels/688863523207774209/688863523211968535)
* [Wiki Reference](https://github.com/GridSpace/grid-apps/wiki)
### Testing Locally
```
git clone git@github.com:GridSpace/grid-apps.git
cd grid-apps
npm i
npm install -g @gridspace/app-server
gs-app-server --debug
```
if installing the app-server fails or gives you permissions errors, then your node installation (on linux/mac) is installed as another user (like root). try instead:
```
sudo npm install -g @gridspace/app-server
```
to start a local instance of the apps. then open
[Kiri:Moto](http://localhost:8080/kiri) or
[Meta:Moto](http://localhost:8080/meta) on your local host
### Windows Developers
this git repo requires symbolic link support. on Windows, this means you have to clone the repo in a command shell with Administrator privileges.
### Other Start Options
```
gs-app-server
```
serves code as obfuscated, compressed bundles. this is the mode used to run on a public
web site.
requires node.js 12+
### Javascript Slicing API
A script include that injects a web worker into the page that will asynchronously perform any of Kiris slicing and gcode generation functions.
https://grid.space/kiri/engine.html