Home

Hey, how’s it going there? Below is a bunch of documenation for Nilai. Read it till your eyes bleed. No seriously, do that.

1. Configuration

[Configuration Files](Configuration-files)

1. Contributing

[How to Contribute](Contributing-to-Nilai)

1. Migrations & Installation
   At this time we require your table types to be set to `InnoDB`. We make use of foreign keys and cascading throughout the app.

You do not have to worry about table type for `migrations` table as we skip this check as it’s just used to track migrations.

NOTE: We currently do not support the `db_prefix` setting in CodeIgniter’s database configs. We have a feature request for this and will be updating the application to support this.

1. Data
   Every view whether a web view, internal XMLHttpRequest request or API call returns the same exact data, just the format changes. Web view returns an array of data just like CodeIgniter wants so it can be turned into PHP variables. The other two will always return a JSON object. The application knows what type of data to return based on the request. All the URLs to access said data stay the same no matter what of response type you require. More information on the logic of how this is accomplished at the data returned per view can be found below.

• [Response Logic](Response-Logic)
• [Data](Data-Points)

1. Error Codes
   The application comes with standard error codes for main actions. Supplementary actions like updating user information, resetting your password, etc also use a specific error reporting logic. Click the link below to read about both.

• [Error Codes](Error-Codes)

1. The Guts
   For those of you who have a thirst for information, feel free to click on the links below if you want to know more about what the application does at the code level. Below are links to controllers, models, libraries, etc. All with in-depth documentation on what there is and the requirements to use it. Enjoy.

1. Controllers

[Plain Controller](Controller-Plain)

[Cron](Controller-Cron)

[Export](Controller-Export)

[Help](Controller-Help)

[Import](Controller-Import)

[Install](Controller-Install)

[JSON](Controller-JSON)

[Labels](Controller-Labels)

[Login](Controller-Login)

[Logout](Controller-Logout)

[Marks](Controller-Marks)

Migrations

[Register](Controller-Register)

[Singletons](Controller-Singletons)

[Tags](Controller-Tags)

Tools

[User](Controller-User)

[Welcome](Controller-Welcome)

1. Libraries

[Exceptional](Libraries-Exceptional)

[JSON Export](Libraries-JSONExport)

[JSON Import](Libraries-JSONImport)

[Plain Migration](Libraries-Plain-Migration)

[Plain Sessions](Libraries-Plain-Session)

1. Models

[Plain Model](Model-Plain)

[Labels](Model-Labels)

[Marks](Model-Marks)

[Tags](Model-Tags)

[Tokens](Model-Tokens)

[User Marks to Tags](Model-User-Marks-To-Tags)

[Users](Model-Users)

[Users To Marks](Model-Users-To-Marks)

1. Helpers

[Data](Helper-Data)

[Hash](Helper-Hash)

[Validation](Helper-Validation)

1. Custom Development
   If you want to extend Nilai, please don’t update the core code. It will make merging our updates into your application a complete pain. Please follow this [guide](Custom) to extend your custom application.