ad-si / brickify

Speed up 3D printing using LEGO® bricks

Brickify

Installation

$ git clone https://github.com/brickify/brickify.git

$ cd brickify

Install dependencies: $ npm install

Link git hooks for automatic code tests and style checks: $ npm run linkHooks

Start Server

$ npm start

In order to continuously rebuild the project and restart the server when source files change you can use supervisor. Install it globally with $ npm install -g supervisor and use it like this: $ supervisor -i build -e node,coffee -- node_modules/coffee-script/bin/cake start (Only necessary for server-side scripts as front-end gets build on the fly.)

Scripts

Run $ npm run to list available scripts. Execute a script like: $ npm run <script-name>

Following scripts are currently available:

• build: Builds client and server js files
• start: Starts server
• linkHooks: Links git hooks
• checkStyle: Checks code-style of coffeescript files
• apiDocumentation: Generates API documentation
• documentation: Generates code documentation
• test: Executes headless tests
• testClient: Executes frontend tests in the browser
• batchTest: Batch test all models and create a HTML report
• prepublish: Prepares publication of project

Package management

We use npm for package management. In order to bundle the modules for the browser we use browserify.

Documentation

We use groc for code documentation and CroJSDoc for api documentation.

Call $ npm run documentation and $ npm run apiDocumentation respectively.

Styleguide

The code must be formatted as described in https://github.com/style-guides/CoffeeScript/tree/v0.1.1

Server

The server currently serves:

• brickify.it: current master-branch
• dev.brickify.it: current develop-branch

brickify's Issues

There should not be a arbitrary list of needed plugin instances

Plugins should interact with the system via hooks and not via passed instances they might possibly need.

use DataPacket system instead of storing computed data to the state

add success callback to modelCache caching

enhance state sanity check in server/statesync.coffee

ToDo: could cause performance problems, maybe replace in the future?

if diffpatch.diff(oldState,state)?
    logger.error 'Diff of identical states was not undefined'

Use promises in stateSync

Only 1s and 0s in batchTest

Following columns seem to display only 1s and 0s.

• stl Import Errors
• stl Invalid Polygons
• stl recalculated Normals

Validate quality of model conversion based on properties and shape

Move stl Import/Optimization to WebWorker

Use promises in objectTree

Remove delta from onStateUpdate hook

Combine client and server plugins

package.json:

{
  "main": "…",
  "browser": "…"
}

make plugins to be instanciable classes, move from modular to oo-programming

Use promises instead of callback hell

See:

• http://callbackhell.com/
• http://www.html5rocks.com/en/tutorials/es6/promises/
• https://github.com/jakearchibald/es6-promise#readme

save batchTesting results while test are performed (not only at the end)

add current git branch&commit to batchTestResult

Rendering Performance Monitoring

https://github.com/mrdoob/stats.js
https://github.com/spite/rstats

Create Landingpage for lowfab

call done when all state manipulation is done in solidRenderer.coffee

we should solve this with promises (#44 ), current implementation is not correct

module.exports.onStateUpdate = (state, done) ->
    objectTree.forAllSubnodes state.rootNode, loadModelIfNeeded, false

    #TODO: this is wrong, since loadModelIfneeded can modify the state
    #TODO: asynchronously. therefore done has to be called when all
    #TODO: loadModelIfNeeded calls are completed. Solve with promises
    done()

Implement findPlanarMeshes

automated model batchTesting on server on every commit to develop

Add express debug panel

https://github.com/devoidfury/express-debug

update readme: remove bower or update to current "frontend system"

Refactor fileLoader, stlImporter and modelCache

Problem (e.g.): /get and /exists are called both when a model is not cached - should be combined in one call.

Also, stlLoader currently does Three-conversion and controls the caching process.

control app by url parameters

• load models
• state association

integrate .stl export

intergrate the existing .stl export in our framework

Display estimated speedup in printing/build time

Displaying exact number would be hard or even impossible, but we might find an easy solution to display estimated factors. ("Prints in 1/2 time")

make voxelizer use proper ui concept

integrate testClient somehow in our existing test framework, use existing models in test/models or use them externally

.. potential copyrighted models shouldn't be in our repository. therefore either use the test/models (created by us) or integrate the other models somehow else.

Use promises in pluginHooks

create automated server backups

update server to fetch from github repo

Use promises in solidRenderer

Fix normal direction

Triangles that specify their vertices in the wrong order will have inverted normals after import.

• We could fix single normals by comparing the vertex order of two adjacent triangles (the vertices should be in reversed order)
• We could implement a robust correction with this algorithm: http://stackoverflow.com/a/761126

fix batchTest not saving results

Progressbar

404 page should not return status code 200

only restart server when updates to develop or master branch are pushed

Use https instead of http

Google ranks tls encrypted websites higher!

Stream state data

This would be another way to improve (perceived) performance by streaming the data from the server:

http://oboejs.com/

Remove / reduce z-fighting

make editor ui functional

make the "import", "view", and "export" tabs functional,
see also #69 and #68

Use promises in modelCache

create Data Packet structure

batchTest: test also for 2-manifoldness

Use promises in dataPackets

deletion of objects

pressing [Del] in scenegraph should delete the selected object

Save UI/rendering configuration in state

Things like

• zoom-level
• viewport
• …

write down what you did this week

http://www.hpi.uni-potsdam.de/baudisch/dokuwiki/hci-bachelorproject-ws14/logbook?&#week-of-2014-11-24

update dummy.coffe to current API

update the dummy plugin to current API definition (still contains old api)

Secure model uploading/fetching

secure the model uploading and fetching so that people can't just access models by their md5 value