Everything you have to know about compound
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
advanced
basics
essentials
README.md
getting-started.md

README.md

Getting Started

Crash course

This is a quick course on CompoundJS. It walks you through creating your first app and will help you learn the basic structure and use of the powerful CompoundJS generators and tools.

Elements Explained

Take a closer look at CompoundJS elements; each fulfills its own function. This guide teaches you how to use each part of CompoundJS and bundle those parts together to create awesome applications.

CompoundJS Essentials

Routing

Draw your application's routing map in a few expressions. This guide shows you the power and beauty of the CompoundJS routing map.

Controllers

Everything you need to know about controllers and the request handling flow: actions, hooks, and the middleware stack.

Models

Brief guide with some examples and advice for JugglingDB starters. This is not a complete guide, but better than nothing. See documenatation for more information about the JugglingDB ORM used in CompoundJS.

View/layouts Rendering

Views, layouts, templating engines and all related stuff (except helpers, because helpers are a big theme worthy of a separate guide).

View Helpers

Everything about built-in and custom-made helpers. Learn how to create your own helpers and helper-related techniques to simplify and beautify your views.

Testing

Learn how to test your application.

Deploy

This guide shows how you can deploy your application.

Security

Types of attacks and how to protect your app against them. Which CompoundJS features could be helpful.

Advanced topics

Meta-programming

Short guide about meta-programming techniques that could be used to apply DRY to controllers and reuse controller code.

Events, Compound API

Learn how to use events to hook up particular application loading stages. Then use API methods to configure CompoundJS for your application needs.

Building Extensions

Let's see how to extend CompoundJS and make your code reusable using the extensions API.

Bitdeli Badge