Introduction

When installing CYJS Framework. you’ll see that files structure :

• css/ : your own custom CSS files
• css/custom.css : overrides CYJS defaults (in CYJS/css/styles.css)
• CYJS/ : the whole framework. You should not have to change anything there, especially if you plan to upgrade to future versions
• html/ : all your HTML files
• images/ : put your own pictures there
• js/ : all your Javascript files
• js/config.js : custom settings to override defaults
• js/lang/ : JS language files
• php/ : your PHP files if needed
• index.html : where everything starts ..

How CYJS is different from others framework ? It just tries to make you lazy .. 😉 .. Well, not really, but it optimizes development time because as a developper, you have to take care about customers needs. CYJS takes care about everything else : dynamic page loading, automatic page transition, widgets display, main and user menus management,  responsive display, country language … , but always letting you free enough to adapt the displayed results according to your needs.

That’s the reason why high level Javascript functions to display basic informations have been often discarded. As in the following new menu entry example, we could have decided to create a Javascript function as CYCreateSideMenu(entries_objects),  but the problem is most of us always needs to customize, some would like icons beside menu text, some would like no icon at all, some would like submenus … CYJS tries to always let you customize the easier way, and the easier way is customizing HTML. As managing cells inside rows – you’ll see later – , or input tag parameters, there are really few things to know to get a nice and clean display. Only few high level Javascript functions are integrated, like dynamic datatables management or input fields, making datatable management with static data and automatic filters and search easier, only HTML knowledge is required.

Very few global configuration is needed, you can edit js/config.js file essentially to set your default language.

debug = 1;
// Project and indexedDB name - NO SPACE !
cyProject = "CYJS-Demo";
// Min window size to display permanent sidemanu
// Must be equal to max-width in media screen section in style.css
cyMinWindowWidth = 1200;
// Small sidemenu width
//cySideMenuSmallWidth = "62px";
// Auto sidemenu when window resizing
//cySideMenuAuto = true;
// Default language
cyLang = 'en';
// Path to app relative to vhost, empty if CYJS on vhost home
cyPath = '/cyjsdemo';
// Default page - REQUIRED
cyDefaultPage = 'cyjsui';
// Cache enabled
// cyCache = true;
// Default delay for alert autofade
// cyAlertDelay = 0;
// Login function
CYLoginFct = function()
{
    CYLoadPage('login', 'IDmain');
    // Default: no login, direct page access
    //CYLogin('MyUsername');
    //CYLoadPage(cyDefaultPage);
    // Pages preloading
    CYLoadPage('cyjstables', 'dummy');
    CYLoadPage('cyjscalendar', 'dummy');
    CYLoadPage('cyjscrm', 'dummy');
    CYLoadPage('myfirstpage', 'dummy');
};
// Main web service
cyWebSvc = "/php/websvc.php"
// Cache enabled
//cyCache = true;
// Sync enabled
//cySync = true;
// Default delay for alert autofade
cyAlertDelay = 2000;
// Tooltip display duration
//cyTooltipDuration = 5000;
// Keepalive - 0 to disable, default is 30s
cyKeepAlive = 10000;
// CSS patterns
//cyCSS.Font = "Varela Round";
//cyCSS.AltBackgroundColor = "#f5f5f5";
//cyCSS.BackgroundColor = "#007fff";
//cyCSS.BorderColor = "#ccc";
//cyCSS.ButtonBackgroundColor = "#eee";
//cyCSS.InputShadow = "#38c";
//cyCSS.InputBackgroundColor = "#fff";
//cyCSS.TextColor = "#333333";
//cyCSS.ReverseTextColor = "#fff";
debug && console.log('config.js loaded');

Note for hackers : both the demo and the installation package are read only, except for file upload feature which the upload directory is controlled with the PHP script : files can only uploaded there, dot names are blocked. There is no other way to upload or change anything. If you really want to test the live edit mode, you’ll have to manually change the php/uploadfile.php and uncomment write features. So please be careful, you should not change this unless you have improved the login authentication that should interact with your server to validate logins. The provided login is just set there as an example, password shoud never be set clear as so and never in a local accessible file.