xone

Xone is an open source Javascript framework for building modern web applications.

Notice

Actually this is a very early state of this repository (pre-alpha or less). We de not recommended using this repo until this message has been removed.

• LICENSE
• CHANGELOG
• Codebase Structure
• Global App Configuration
• Basic Examples: MVC Pattern / Routes / Events / Templates/ Dev Tools
• Working with Persistent Models
• Xone Core Library

Installation

> npm install -g xone

Note: To make the Xone CLI globally available, you have to install Xone as a global npm module. You can also manage multiple/custom versions of Xone (read further).

Create New Xone Project

Create a new project inside the directory path\to\my\workspace\my_project:

path\to\my\workspace> xone create "my_project"

Create a new project inside the current directory:

path\to\my\workspace\my_project> xone create .

Force overwrite an existing Xone project:

path\to\my\workspace\my_project> xone create . --force

Note: Be careful, this command will also reset most of the existing project files!

Update existing Xone project (fetch from global npm_modules installation)

Fetch update:

> npm install -g xone

Install update to an existing project

path\to\my\workspace\my_project> xone install

Manage multiple versions

Install local version of xone:

> npm install --save xone@0.2.1

Update existing Xone project (fetch from a local npm_modules installation)

path\to\my\workspace\my_project> xone install local

Update existing Xone project (fetch from any custom location)

path\to\my\workspace\my_project> xone install /lib/xone_0.2.1/

Note: In addition to at least one global installation to make the Xone CLI available.

Alternatively you can skip the global installation and call the node binaries located in the xone/task/ folder directly within your current Xone project. Check Xone installation path (example):

path\to\lib\xone_0.2.1> node task/version

Create new project:

path\to\my\workspace> node ../lib/xone_0.2.1/task/create "my_project"

Update existing project:

path\to\my\workspace\my_project> node ../../lib/xone_0.2.1/task/install

TODO

• Provide stand-alone version
• Provide dependency-less version
• Install/Setup/Update (CLI)
• Use npm modules for system tasks (supports all platforms)
• Improve Environment Mappings
• Improve Worker Integration

Xone actually requires:

• Node.js
• Closure Compiler
• YUI Compressor
• Jasmine

NOTE: Alle these libraries are planned to become optionally.

Features

• Manage Process Environments:
  • production
  • development
  • test
  • benchmark
• Manage Rack Environments:
  • webapp
  • cordova
  • native
  • local
  • browser
• Manage Platform Environments:
  • Android
  • iOS
  • Windows
  • Webkit
  • Mozilla
  • MSIE
• Model-View-Controller
  • Supports persistent models
• Full MVC-managed handlers:
  • Routes
  • Events
  • Cache
  • Mapper
  • Storage
  • Threads / Worker
• JavaScript Core Library
• Codebase Dependency Management
• Supports DOM pattern in JSON format
• Template System (Static Views, Dynamic Views)
• Build System
• Template Compiler
• Layout Manager
• Support Multi-Platform-Injections
• Event Delegation
• NoSQL Persistent Storage
• GZIP Storage Data Compression
• FlexiCache
• Multi Language Support
• Specs, Integrated Test Environment (based on Jasmine)
• Debug Mode
  • Debugger Tools
  • Performance Tools
  • Analytics/Statistic Tools
• Benchmark Integration
• Supports JavaScript Closure Compiler (make use of "Advanced Compilation" by default)
• YUI CSS Compressor Integration
• Compatible with almost each library out there
• Also can be mixed with similar technologies like: Angular or react
• Simple, fast and natural usage out of the box