Skip to content

Latest commit

 

History

History
116 lines (95 loc) · 4.56 KB

README.md

File metadata and controls

116 lines (95 loc) · 4.56 KB
Raw

Xeon Js

The Single Page Web Framework.

  • Frontend & Backend : You can write both frontend and backend code from a single project and serve frontend code.
  • No Reload : Nevegate through the app without reloading the page using "data-link" attribute to any anchore tag or use "nevigateTo(url)" function in javascript.
  • Change title or icon : Change app title or shortcut icon for each routed page using function "this.setTitle(title);" & "this.setIcon(url);".
  • Component Based : You can create view components and use them any where in the app by importing it. This helps to create complex user interface. The component actuly made with html are usely written in javascript function, and used return statement.
  • Auto Refresh : Automatically refresh the page on change of any file. Only in development mode.
  • Error Overlay : Show the error in the code on to the dom. Only in development mode.

Installation

Xeon Js is perfectly designed to be used from anywhere either npm or cdn.

  • CDN : xeon js can be impliment from cdn. But there we need to notice that for every endpoint the index.html file have to be served.
<script type="module" src="https://unpkg.com/xeonjs@latest/files/xeon.js" ></script>
  • NPM : The folder structure of a xeon app in npm is very simple. There is only two folders and a file is all that we need. Unfortunetly curently we don't have any npm script for start up template. But you can find a startup template Here.
  • Xeon-cli : Xeon-cli is a very powerful tool to create xeon app with a single line of code. You can find verious templates for your app.
npx xeon-cli create-app <app_name> --template=<template_name> --git --updateNpm

Read More at : Xeon-cli.

Documentation

Xeon JS is very simple and totaly based on browser javascript.

Folder Structure.

 App
 ├───node_modules/ ( npm packages )
 ├───assets/ (This folder can directly be called from anywhere using "/assets/<file_name>")
 ├───src/ ( Store your views here )
 ├───index.html ( only html file )
 ├───index.js ( Main Xeon Entry Point )
 ├───package-lock.json ( node_modules/ folder tree stayed here. Used for version control for npm packages. Learn More: https://docs.npmjs.com/cli/v7/configuring-npm/package-lock-json )
 └───package.json ( App Details Exists Here. Learn More: https://docs.npmjs.com/cli/v7/configuring-npm/package-json )

Hello World Example.

You can download the example project from https://github.com/chatcord/Xeon-JS-Hello-World/

  1. create a new project
  2. Initialize the project. ( Execute the code npm init in the command line in the directory )
  3. Install Xeon JS in the project ( Execute the code npm i xeonjs in the command line in the directory )
  4. Create "start" script in the /package.json file ( /package.json file should look like this )
{
  "name": "<App_name>",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "start": "xeon-script start", [This_line_Should_be_added]
    "prod": "xeon-script start -prod" [This_line_may_be_added]
  },
  "author": "",
  "license": "ISI",
  "dependencies": {
    "xeonjs": "^1.1.0"
  }
}
  1. Now create the following 3 files and add the codes.
  • /public/index.html
<!DOCTYPE html>
<html lang="en">
<head>
      <meta charset="UTF-8" />
      <meta http-equiv="X-UA-Compatible" content="IE=edge" />
      <meta name="viewport" content="width=device-width, initial-scale=1.0" />
      <title>Xeon Js</title>
      <!-- Add all your links here -->
</head>
<body>
      <!-- Div with id 'root', here all your code will appear -->
      <div id="root"></div>
      <!-- An module script will be added here from backend -->
</body>
</html>
  • /index.js
// This file is mandatory.
// Actual Xeon js will find this file and execute.
// This is an module script directly executes in the browser.

// import xeon js.
import xeon from '/xeon';

/**
 * configure your app.
 * 
 * @syntax xeon.config(<xeon-element>, <target-element>);
 */
xeon.config(
      xeon.createElement("h1", {}, "Hello World"),
      document.getElementById("root")
);
  1. Now enter the command npm start in the command line in the project directory.
  2. Then in the browser you can browse http://localhost:5000/ to see the app.