tree: cc483953480d8e529f2db47530e21f8bf8f85218 [path history] [tgz]
  1. .gitignore
  2. .project
  3. .settings/
  4. README.md
  5. build/
  6. index.js
  7. lib/
  8. orion.conf
  9. package.json
  10. server.js
  11. test/
modules/orionode/README.md

Orionode

A minimal, single-user deployment of Eclipse Orion. Use for hacking files on your computer using Orion's editing environment.

Features

  • Basic Navigator operations
  • Basic Editor operations
  • Plugin operations
  • Shell command for launching a node app (type help node in the Shell page to find out more)
  • Shell command for supporting npm.
  • Client caching for static content
  • Gzip
  • Concatenation and minification of pages

Usage

Running the server

Run npm start orion or node [node_modules]/orion/server.js.

Using Orion within a larger app

Use require('orion') to get access to our startServer function, which is suitable for use within a larger connect project:

var orion = require('orion');
var connect = require('connect');
var myapp = connect()
    .use(orion({ workspaceDir: '.myworkspace' }))
/* .use( additional handlers ) */

For full instructions, see the Getting Started guide.

Running the tests

We use Mocha for our tests. Run npm test or mocha.

License

Dual-licensed under the Eclipse Public License v1.0 and the Eclipse Distribution License v1.0.