Skip to content

SQL preview web UI design

Jump to bottom Edit New page
Tako Lee edited this page Apr 1, 2014 · 4 revisions

Create a front web UI application, help end user to pickup SQL format options via web page using wizard mode. Able to preview SQL format during setting value for various format options. After user choosing value of all format options, save format option and values in a file with json or XML format.

  1. Format options need to be supported： https://github.com/sqlparser/sql-pretty-printer/wiki/sql-preview-select-list

  2. According to different type of format options, create corresponding UI element, so user can select values quickly and easily. （All types of format option see "Types of format option" section in this page: https://github.com/sqlparser/sql-pretty-printer/wiki/SQL-Coding-Standard-and-Guideline）

  3. Format options should be organized in a hierarchical structure (tree structure). Sub-level format option will be available only parent options set to certain values.

  4. Each time when a value for a format option was selected, UI application should send current format option set together with a SQLID to backend program. Backend program will send back formatted SQL, UI application show this formatted SQL in preview area with syntax highlight.（Backend program is already available, UI application only need to communicate with this program.）

  5. When preview formatted SQL code, This UI application show it exactly as what backend program send to it.

  6. Size of this UI application is 1024*768

  7. Here is a reference of this UI application. But it's only for your reference, you should build your own. https://github.com/sqlparser/sql-pretty-printer/blob/master/sqlpreview_front_ui.png

  8. All format options and it's value should be saved in a text file in json or XML format，able to represent the hierarchical structure of all format options. This file should be saved in a directory in server side, using timestamp as file name.

  9. You should know AJAX,CSS,json or XML, able to use github

  10. This job should be finished in 2 weeks.

  11. This job is a part of a big project. hope we can create a long term partnership.

PP V3 format options

Add a custom sidebar
Clone this wiki locally