Skip to content

j-show/jshow

Repository files navigation

jShow logo

jshow-ci jshow-co jshow-dm jshow-ver

jshow-lic jshow-ct


Supporting

jShow is an MIT-Licensed open source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider:

What's the difference between Patreon and OpenCollective?

Funds donated via Patreon go directly to support jShow You's full-time work on jShow. Funds donated via OpenCollective are managed with transparent expenses and will be used for compensating work and expenses for core team members or sponsoring community events. Your name/logo will receive proper recognition and exposure by donating on either platform.


Introduction

jShow is an open tool framework. It's designed to support both WebBrowser, Node.js environment, it's composed of core tool library,external components,generator helper.

  • core tool library It's like a Swiss army knife. It helps you simplify your code. Anyone can use it to create their own tool library.

  • external components Automatically identify environmental patterns, follow the light component principle, load the following components as needed

    • any to conver conversion function, provide various types of fool conversion function
    • check & regexp a variety of common checking functions
    • calc date Extend the time conversion function and integrate some convenience functions
    • calc string Extended string processing function for special recognition of double-byte characters
    • encryption Common encryption and decryption calculation function, including hash, CRC and other common data calculation function
    • module loading framework Modular development framework, with async function as the core, asynchronous load page module
    • front-end routing Through simple configuration, the front-end routing structure is established and the single-page application is developed easily
    • DOM operation Simple DOM operation object, fully compatible with jQuery operation mode
    • gesture recognition For Mobile terminal, simple gestures can be identified in series by setting to recognize complex gestures
  • generator helper As the core library of the entire jShow's Family, jshow provides a global installation method that can generate sample projects of the corresponding framework through parameters.

    • jshow-svr Provide HTTP/HTTPS/HTTP2 backend services, fully compatible with Koa@2 middleware, integrated multilingual solutions, RESTful API, MVC and other code mode.
    • jshow-socket Socket data flow framework is provided to support TCP/UDP/WebSocket data flow parsing operations.
    • jshow-nano Provide hardware operation, business process control, support GPIO/SPI/serial/bluetooth operation, integrate part of GPS,4g,QR module reading and writing

Ecosystem

Project Status Description
jshow jshow-ver jShow ecosystem core
jshow-svr jshow-svr-ver HTTP Service Framework, compatible with HTTP/HTTPS/HTTP2
jshow-socket jshow-socket-ver Socket Service Framework, compatible with TCP/UDP/WebSocket
jshow-nano jshow-nano-ver ARM Control Framework, compatible with GPIO/SPI/serial/bluetooth

Folder

──
 └── gulpfile.js     //gulp script file
 └── build.json      //modules configuration
 └── dist            //output folder
 └── src             //source folder
 │ └── jShow.js      //main script file
 │ └── Generator.js  //generator script file
 │ └── loading.js    //external components configuration
 │ └── bin           //generator script folder
 │ └── core          //core tool library folder
 │ └── lib           //external components folder
 └── test            //mocha test folder

Install

  • Code Mode

     const jShow = require("jshow");
     
     console.log(jShow.version());
  • Generator Mode

     $ npm install -g jshow
     
     // create RESTful api project
     $ jshow svr init --package a /data/example_api

Documentation

To check out live examples and wiki docs, visit jshow.org.


Questions

For questions and support please use the official forum or community chat. The issue list of this repo is exclusively for bug reports and feature requests.


License

MIT


Copyright (c) 2019 jShow.org