https://github.com/ad-si/brickify

Speed up 3D printing using LEGO® bricks
https://github.com/ad-si/brickify

3d-printing fabrication lego prototyping webapp

Last synced: 8 days ago
JSON representation

Speed up 3D printing using LEGO® bricks

• Host: GitHub
• URL: https://github.com/ad-si/brickify
• Owner: ad-si
• Created: 2014-11-26T11:58:38.000Z (almost 10 years ago)
• Default Branch: develop
• Last Pushed: 2015-10-27T07:46:39.000Z (about 9 years ago)
• Last Synced: 2024-05-02T05:41:02.624Z (6 months ago)
• Topics: 3d-printing, fabrication, lego, prototyping, webapp
• Language: CoffeeScript
• Homepage:
• Size: 33.3 MB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 99
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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 `

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](https://npmjs.org) for package management.

In order to bundle the modules for the browser we use [browserify](http://browserify.org).

## Documentation

We use [groc](http://nevir.github.io/groc/) for code documentation

and [CroJSDoc](http://croquiscom.github.io/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](http://brickify.it): current master-branch

- [dev.brickify.it](http://dev.brickify.it): current develop-branch