compoundjs / guides Goto Github PK

Everything you have to know about compound

Home Page: http://compoundjs.github.com/guides

guides's Introduction

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.

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.

guides's People

Contributors

Stargazers

Watchers

guides's Issues

Guides may require a proofread?

Hi!
I'm sorry if this is out of line but I seem to have noticed a pattern with the basics/crash-course.md file where phrases are missing the word "the", for example "Let's start with routes, because this is first place in the compound stack", my feeling is that this might read better as "Let's start with routes, because this is the first place in the compound stack".

From what I've read so far the compoundjs may soon become my new goto back-end framework, I'd be happy to do a pull request with some proofreading done on the crash-course.md file.

Links are broken

All the links on guide web page are broken. http://compoundjs.github.com/guides/

broken link

on http://compoundjs.com/

Elements Explained goes to

https://github.com/compoundjs/guides/blob/master/elements-explained.md

but I think you meant for it to go to

https://github.com/compoundjs/guides/blob/master/basics/elements-explained.md

Unexpected string

After running
==> compound init myapp
and
==> npm install
and
==> compound generate scaffold list name
and
==> node .
I get the following error :
express deprecated app.configure: Check app.get('env') in an if statement config/environment.js:6:9
connect deprecated methodOverride: use method-override npm module instead config/environment.js:16:25
express deprecated app.configure: Check app.get('env') in an if statement config/environments/development.js:6:9
undefined:26
List = describe 'List', ->
^^^^^^
SyntaxError: Unexpected string
at Function (native)
at loadSchema (/work-ssd/compoundjs/myapp/node_modules/jugglingdb/lib/railway.js:107:18)
at init (/work-ssd/compoundjs/myapp/node_modules/jugglingdb/lib/railway.js:74:9)
at initialize (/work-ssd/compoundjs/myapp/node_modules/jugglingdb/index.js:94:13)
at Object.exports.init (/work-ssd/compoundjs/myapp/node_modules/jugglingdb/index.js:83:9)
at /work-ssd/compoundjs/myapp/node_modules/compound/lib/server/extensions.js:27:23
at Array.forEach (native)
at init (/work-ssd/compoundjs/myapp/node_modules/compound/lib/server/extensions.js:25:18)
at CompoundServer.module.exports as extensions
at CompoundServer.initCompound (/work-ssd/compoundjs/myapp/node_modules/compound/lib/compound.js:127:14)
at CompoundServer.initCompoundServer as init
at /work-ssd/compoundjs/myapp/node_modules/compound/lib/compound.js:84:22
at process._tickCallback (node.js:355:11)
at Function.Module.runMain (module.js:503:11)
at startup (node.js:129:16)
at node.js:814:3

Removing intermediate things

Here is the structure i propose:

Getting started - Crash course to CompoundJS. Create your first app, learn structure, use generators and tools.
Compound essentials
Compound structure
Routing
Controllers
View/layouts rendering
View helpers
Testing
Deploy
Advanced
Security
Meta-programming
Events, Compound API
Building extensions

Quickstart Guide Issue

Hello,

I have followed the quickstart guide:
https://github.com/compoundjs/guides/blob/master/basics/crash-course.md

But when I try to start the todo-list-app i get the following error:

daslicht:todo-list-app daslicht$ node server.js

/Users/daslicht/compound/todo-list-app/config/environment.js:11
        app.loadConfigs(__dirname);
            ^
TypeError: Object function app(req, res, next){ app.handle(req, res, next); } has no method 'loadConfigs'
    at Function.<anonymous> (/Users/daslicht/compound/todo-list-app/config/environment.js:11:13)
    at Function.app.configure (/Users/daslicht/compound/todo-list-app/node_modules/express/lib/application.js:392:61)
    at module.exports (/Users/daslicht/compound/todo-list-app/config/environment.js:6:9)
    at requireIfExists (/Users/daslicht/compound/todo-list-app/node_modules/compound/lib/compound.js:233:27)
    at CompoundServer.configureApp [as configure] (/Users/daslicht/compound/todo-list-app/node_modules/compound/lib/compound.js:215:5)
    at CompoundServer.initCompound (/Users/daslicht/compound/todo-list-app/node_modules/compound/lib/compound.js:111:18)
    at CompoundServer.initCompoundServer [as init] (/Users/daslicht/compound/todo-list-app/node_modules/compound/lib/server/compound.js:53:29)
    at /Users/daslicht/compound/todo-list-app/node_modules/compound/lib/compound.js:79:18
    at process._tickCallback (node.js:415:13)
    at Function.Module.runMain (module.js:499:11)
    at startup (node.js:119:16)
    at node.js:901:3
$

what am I missing ?