README.md

Divergence Framework Documentation

Table of Contents

• Getting Started

  • Server Prerequisites
  • Bootstrap a New Project
  • How to Bootstrap Manually (Advanced)
  • Establish Your Classes Directory
  • Configure Database Access
  • Configuring nginx or apache2 Servers

• Architectural Concepts

  • Request Respond Emit
  • Tree Routing

• Command Line Tool

  • Installation
  • Initializing a Project
  • Testing Your Database Config
  • Change Your Database Config
  • Tool Usage Reference

• Project Structure

  • Load Order
  • Folder Structure
  • The App Class
  • Configs
  • Development & Production
  • Error Handling

• ORM

  • Model Architecture
  • Making a Basic Model
  • Create, Update, and Delete
  • Versioning
  • Relationships
  • Supported Field Types
  • Canary Model - An Example Utilizing Every Field Type
  • Validation
  • Event Binding
  • Advanced Techniques

• Controllers

  • Intro to Tree Routing
  • RequestHandler
  • Your Own Controllers
  • RecordsRequestHandler
    • Building an API
    • Permissions
    • JSON API Reference
      • Browse (Read Many)
      • One Record (Read One)
      • Edit One Record
      • Create One Record
      • Delete One Record
      • Create or Edit Multiple Records
      • Delete Multiple Records
  • Advanced Techniques

• Views

  • Responding with a Template

• Security

  • User model
  • Session model
  • Authentication
  • Binding Permissions

  Note: While these things are already built (and running in production on many many sites) they are yet to be unit tested so for now they remain on the road map for future versions.

• Developing

  • Get the Source Code
  • Unit Testing
  • Style Guide

• Addendum

  • About