Xone provides a lightweight full stack environment to develop beautiful applications for every use and enables the optimal integration of an universal codebase into a wide range of systems (e.g. mobile devices, tablets, desktops, browser environments).
Notice: Actually this is an alpha state of this repository. Some breaking changes could possibly be introduced in upcoming versions. Do not use for production until this message has been removed.
Xone basically is available in 3 different versions:
xone create| Features by default | Xone Project (Environment) | Xone Bundle (Standalone) | Xone Library (Standalone) |
|---|---|---|---|
| Final project filesize | smallest | small | normal |
| Core Library |  | | |
| MVC Framework | | | |
| Render Engine | | | |
| Unit Tests | | - | - |
| Debugging Tools | | | - |
| Environments | | - | - |
| Global App Configuration | | | - |
| Build/Compile Project | | | - |
| Manage Platforms | | - | - |
| Dynamic Templates (HTML > JSON) | | - | - |
| Dependency Management | | - | - |
| Initial Codebase | | - | - |
| CLI Tools | | - | - |
| Support Closure Compiler Advanced Mode | | | - |
| Dead Code Removal | | | - |
| Not strictly bound by Conventions | - | | |
| Does not require Node.js | - | | |
| Use as a Standalone Library (like jQuery/Underscore) | - | | |
| Use as a Framework (like Bootstrap/Angular) | | | - |
| Use as a Dev Environment (like Sencha/Meteor) | | - | - |
> npm install -g xone
Note: To make the Xone CLI globally available, you have to install Xone as a global npm module (also in addition to any local installation if you want to keep simple as most as possible). You can also use a local custom versions of Xone as well as using the CLI without any global installations (read further).
Note: Xone Project binaries typically has to be installed via "xone create" or "xone install" and comes with its own pre-defined folder structure (followed by some conventions). You can pick one of the two stand-alone versions optionally to skip as many conventions as possible (e.g. Xone acts like an extern Javascript Plugin).
Alternatively in the root of your project you can use the local CLI shortcut app instead for xone, e.g.:
my_project> app build
Note: The options create and install both are not available over the shortcut app.
On a linux machine you may use:
sudo npm install -g xone
If the global "xone" identifier is not registered properly try one of these lines:
hash xone
hash -r
Alternatively you can use the local CLI fallback like:
bash xone build
Create a new project inside the directory workspace/my_project:
workspace> xone create my_project
Works, but it is generally not recommended to use whitespaces in a project folder name:
workspace> xone create "my project"
To update Xone of an already existing project you basically need 2 steps:
> npm install -g xone
workspace/my_project> xone install
Note: This will not overwrite any of your project files! Only projects xone library files located in app/lib/xone/ are updated.
Un-compiled sources located in: workspace/my_project/app/*
my_project> xone build
Production build located in: workspace/my_project/bin/www/*
Note: We recommended to use production builds for any external/public release and use the sources only for developing, testing and may some other internal purposes. To skip the build integration of Xone, you have to use the standalone version instead.
my_project> xone server
Open your preferred webrowser and goto 'http://localhost/app/' or 'http://localhost/bin/www/'
Optionally you can pass custom host and port:
my_project> xone server localhost 8080
Open your preferred webrowser and goto 'http://localhost:8080'
Open app/index.html from sources or bin/www/index.html from production build in your preferred browser.
Use production builds located in workspace/my_project/bin/* to move forward into your Cordova-based projects or upload to a webserver.
Xone provides custom platform injections to perform platform specific production builds. Therefore all those builds only includes necessary code and dependencies for their related platform.
Show currently defined platforms:
my_project> xone platform
Perform platform specific compilation:
my_project> xone compile android
Compiled files remains in: workspace/my_project/app/*
Perform platform specific builds:
my_project> xone build android
Build destination: workspace/my_project/bin/android/*
You can add unlimited custom platforms, e.g. create a platform 'webapp':
my_project> xone platform add webapp
my_project> xone build webapp
Build destination: workspace/my_project/bin/webapp/*
my_project> xone build bundle
Build destination: workspace/my_project/app/lib/xone/dist/xone.bundle.js
my_project> xone build lib
Build destination: workspace/my_project/app/lib/xone/dist/xone.lib.js
my_project> xone build lib min ./app/js/
Build destination: workspace/my_project/app/js/xone.lib.min.js
Note: The order of passed parameters cannot be changed actually.
Xone build uses the Google Closure Compiler. All Xone libraries also supports compilation in "Advanced Mode". The build properties can be configured in xone.json. The Closure Compiler also provides a simple dependency management system (provide/require) you should make use of to improve dead code removal.
Note: Actually Xone supports 2 different versions of closure compiler: 1. requires Java, 2. requires Javascript (Node). It is recommended to have a Java (JRE) properly installed on your machine to unlock some benefits of the Closure Compiler Java version. To change the type of the compiler you need to change the value of the field
closure_compiler_lib_typefrom"js"into"jar"inxone.jsonaccordingly.
Note: If you have less experience with the Closure Compiler you can optionally set the compilation level to "simple" on the field
closure_compiler_levelwithin the xone config file.
| Features by default | Closure Compiler (Java) | Closure Compiler (Javascript) |
|---|---|---|
| Dependency Management | | |
| Auto Sort Dependencies | | - |
| "Strict" Dependencies (Entry Point) | | - |
| "Pretty Print" Compilation | | - |
| Build Performance | Normal | Slow |
| Compression Ratio | Best | Good |
| Memory Consumption | Normal | Extreme |
my_project> xone docs
Docs will be generated in 'docs/api/'.
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
</head>
<body>
<!-- END_OF_BODY -->
<!-- LOAD XONE: -->
<script src="js/xone.lib.min.js"></script>
<!-- YOUR APP CODE: -->
<script src="js/app.js"></script>
</body>
</html>
The render engine provides an optional "fast mode" to get the most out of performance. All internal processes of Xone takes advantage when "fast mode" is enabled (e.g. render templates, animate elements, toggle views). When it runs in "fast mode" the render engine has a very closed infrastructure you should keep notice:
Note: When "fast mode" is enabled it should not be mixed by any other external manipulations of the same category listed above. We recommended to disable the "fast mode" when style issues occurs by any direct style manipulations (e.g. when using an extern library).
Note: The "fast mode" is enabled by default in a Xone Project (may change in future) and is disabled by default in the Xone Extern Library.
The problem:
var display;
// get style direct:
display = document.getElementById('my_div').style.display;
console.log(display); // -> 'block'
// set style Xone:
CORE.setStyle('my_div', 'display', 'none');
// get style Xone:
display = CORE.getStyle('my_div', 'display');
console.log(display); // -> 'none'
// get style direct:
display = document.getElementById('my_div').style.display;
console.log(display); // -> 'block' !!!
Instead do this:
var display;
// set style Xone:
CORE.setStyle('my_div', 'display', 'none');
// do on next refresh:
CORE.paint(function(){
// get style direct:
display = document.getElementById('my_div').style.display;
console.log(display); // -> 'none'
});
Default environments are:
Change environment in app/manifest.js:
"env": "development",
"platform": "www"
Or just adding parameters to the URL:
http://localhost:9000/?env=test&platform=android&debug=true
Note: You are also able to override any
CONFIGattribute by passing URL parameters respectively.
Show currently defined environments:
my_project> xone env
Add custom environments:
my_project> xone env add offline
Build destination: workspace/my_project/app/config/offline.js
FAQs
Open source Javascript framework for building modern web applications.
The npm package xone receives a total of 29 weekly downloads. As such, xone popularity was classified as not popular.
We found that xone demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.Ā It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.