API Reference
(advanced-users can start here)

Welcome To VorkJS Documentation Website

VorkJs is a web development framework for node.js, its in aid to help javascript developers to expierment with something new and help create scaliable Website Apps with NodeJS in simular ways to vork and cakephp.

  • 3rd Party Ingredients (npm modules)

Understanding VorkJS's MVC

MVC stands for Model View Controller and is symbolic for an architecture that (respectively) separates your data model (SQL or MongoDB interface and database access), front-end display view (HTML, JavaScript, CSS, etc.) and the business logic that controls the flow of your application (application-specific Javascript code.) This allows your designer to reskin your web site, your database administration to optimize database, and your developer to add functionality without interfering with each other. Each typical web page that you visit is generated from a single view and has the logic powered by a single controller which gets the data that appears on the page from one or more models. MVC has matured to also include additional units:

  • Layouts - a master view that wraps around the content of each regular view, commonly used to provide a general page layout, header and footer
  • Views & Elements - reusable chunks of display code that can be used within any number of views. A view can include any number of elements and elements can be used within any number of views
  • Components - dependentless plugins that initalize into vork that mask the whole vork process for scaliablity
  • Helpers - tools available in your views, layouts and elements to simplify front-end development. Helpers in Vork include tools for form generation, automatically turning an array of URLs into a bulleted menu, embedding a YouTube video and more.

Understanding the URL structure

Everything that comes after http://www.YOURVORKSITE.com/ is parsed by Vork. For example, http://www.YOURVORKSITE.com/products/widget/small/green would have the products/widget/small/green interpreted by Vork. The first level, products, is called the controller and the second, widget, is the action. Anything after this, small and green, is considered "parameters" or "params" for short. So the format is:


All the URL parts are optional and there is no limit to the number of parameters that you can have. If the controller or action is missing then Vork will default to using the "index" controller or action.