Coder Social home page Coder Social logo

fork2-builder's Introduction

This authoring tool helps you create workshop-like courses.

Requirements

For now, this project needs coffee script. To install coffeescript globally for your user, run

npm install -g coffee-script

We'll remove this requirement in future versions.

Installation

Install the stable release from NPM

npm install -g fork2

If the install had been successful, running the fork2 command should output some help message,

> fork2
Fork2 Version 0.0.1
The available commands are:

  help - Show detailed help for a command
  compile-template - Compiles a single content template.
  build-project - Builds a given project to an output path.
  run - Runs a built project.

Local Path Installation

NPM allows you do install a package on your local path. To install fork2 that way, just cd into the path you want, and run

npm install fork2

To get access to the fork2 bins, be sure to add the local node_modules bin path to your PATH environment variable. Like so,

export PATH=$PATH:./node_modules/.bin

To Build And Run a project

cd $PROJECT && fork2 build && fork2 run --port 3000

Documentation

See the wiki

Contributing

See the HACKING guide.

License

This project is under the MIT License.

fork2-builder's People

Contributors

hayeah avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

fork2-builder's Issues

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.