MoknJ 0.0.1 API

Notice

Version 0.0.1 is a quick and dirty prototype.

Mission

MoknJ started as an idea to move data from excel sheets to an customizable platform.

Technology Stack

HTML5, CSS, Bootstrap, AngularJS, AngularUI, Angular Routing, Node, Express, Spring Boot, Spring Security (OAuth 2), Mongo DB, Java 8, Rest (Jersey with Jackson), Maven, Junit

Running API

When this app starts for the 1st time you will see your username and password printed in the logs (this is your admin user). To start using the app you need to create template 1st with your respected fields mapped out then just add that template to menu (create menu) item and you are set. Repeat that few times with few unique templates and menu mappings and you've got yourself a web app or a glorified potato (WHUTTT!!!!? OOHMY GHUD I LOVE POTATOS!)

2017-03-14 21:33:29.744  INFO 448 --- [io-8084-exec-21] n.i.fixx.moknj.runner.ServerInitializer  : ########Remove me in production########
2017-03-14 21:33:29.744  INFO 448 --- [io-8084-exec-21] n.i.fixx.moknj.runner.ServerInitializer  : Admin : user
2017-03-14 21:33:29.744  INFO 448 --- [io-8084-exec-21] n.i.fixx.moknj.runner.ServerInitializer  : Password : user!2
2017-03-14 21:33:29.744  INFO 448 --- [io-8084-exec-21] n.i.fixx.moknj.runner.ServerInitializer  : #######################################

High level break down

• Rest API which which uses token authentication to identify the logged in user.
• The platform is split up in 2 applications (GUI) (Node.js app) and API (Spring boot app). This creates the impression when using the app that is fast.
• As the GUI only handles rest (ajax) request and display (data manipulation) with the API which is tomcat/tomee/wildfly free to handle db related requests and data manipulation.
• GUI is pure HTML5 and javascript which makes it easy for most developers to contribute to.
• Templates(components with fields) and menu's (componente with multiple templates), templates and menu's are dynamic or abstract.
• Home Page Setup contains graph components which can be added/modified to generate statistics on individual templates.
• Change the database structure on the fly like a spreadsheet.

Low level break down (Also high level but more detaaail hah!)

Template

Templates represent components in the platform. Templates define the fields and field behavior. Templates are linked to menu (pages). See menu for more information.

• Template consists out of multiple fields, which can be manipulated and saved. (Showed in red box of screen shot)
• Name of field to be displayed on the page. (Shown in green box of screen shot)
• Field Type consists out of few types namely text, number, date, monetary. (Shown in blue box of screen shot)
• Field Index, the index of the field on the view of the template. (Showed in red box of screen shot)
• Drop down fields are fields which have multiple values. These fields are displayed as you guessed a drop down...
• Templates also have behavior (Asset, Employee, more to come as we expand the functionality) assigned to them.

Menu

Menu item consists out a group of templates which represent a single page in the platform. The platform allows for multiple menu assigned to main modules.

• Name of Page and Name of Menu Item to link to the page.
• Index of menu item in menu list.
• Group of templates. Templates can be order to display above one another.

See screen shot for example of edit menu screen.

Module

Modules can be seen as view and behavior of a template and menu. The module dictates the view display.

• Asset view contains a horizontal view list views.
• Employee view contains a horizontal user filter shown in red and tab view shown purple and list view shown in green.

User

Users and employees are one of the same, a user is just an employee with user access. Employees can be linked to the assets and employee templates records.

Example of user view/new screen

Access

User access can be defined once menu and template is loaded to the platform. The user access is stored in the access table, note that user access is assigned to template and menu id and user id with a right (new,update,delete,view). This access is linked to user and the user is linked to token. The token is used to check if any action to rest api is allowed like view or deleting. Also keep in mind that this system has no session for the front end but token expiry date.

Screen shot info

• MoknJ API Access rights in the red box, is used to define access to rest controller or path.
• Page access in blue box this used to give the user access to the template and menu item.

How do I get set up?

Dependencies

• Node.js (latest)
• npm (latest)
• Maven 4
• Mongo
• Mongo chef core (Mongo db editor)

Configuration

MoknJ/src/main/java/application.yml

environment: 
system:
    db: moknj
    url: localhost
    port: 27017
    username: 
    password: 
admin:
    user: fixxit
    pass: fix!2
security:
    realm: FIXX_OAUTH_REALM
    client: fixx-trusted-client
    secret: fixx_secret
    tokenValiditySeconds: 72000
    refreshTokenValiditySeconds: 72000
    resourceId: fixx_rest_api

• System settings contains the db settings.
• Admin is for you system administrator (All access, used for installation/mapping of system)
• Security settings contains all OAuth settings.