mihaipantiru / criollo Goto Github PK

Criollo helps create really fast standalone web apps that deliver content directly over HTTP or FastCGI. You can write code in Objective-C or Swift. And you can use technologies you know and love: Grand Central Dispatch, NSURLSession, CoreImage and many more.

It's as easy as this:

CRServer* server = [[CRHTTPServer alloc] init];
[server addBlock:^(CRRequest * request, CRResponse * response, CRRouteCompletionBlock completionHandler) {
    [response send:@"Hello world!"];
} forPath:@"/"];
[server startListening];

and in Swift:

let server:CRServer = CRHTTPServer()
server.addBlock({ (request, response, completionHandler) -> Void in
	response.send("Hello world!")
}, forPath: "/")
server.startListening()

Criollo was created in order to take advantage of the truly awesome tools and APIs that OS X and iOS provide and serve content produced with them over the web.

It incorporates an HTTP web server and a FastCGI application server that are used to deliver content. The server is built on Grand Central Dispatch and designed for speed.

Criollo can easily be embedded as a web-server inside your OS X or iOS app, should you be in need of such a feature, however it was designed to create standalone, long-lived daemon style apps. It is fully launchd compatible and replicates the lifecycle and behaviour of NSApplication, so that the learning curve should be as smooth as possible.

See the Hello World Multi Target example for a demo of the two usage patterns.

• Download Criollo and try out the included OS X and iOS example apps. Criollo requires CocoaAsyncSocket, so do not forget to download it into Libraries/CocoaAsyncSocket.
• Read the “Getting Started” guide and move further with the “Doing More Stuff” guide
• Check out the documentation for a look at the APIs available
• Learn how to deploy your Criollo apps in the “Deployment” guide

The preferred way of installing Criollo is through CocoaPods. However, you can also embed the framework in your projects manually.

1. Create the Podfile if you don’t already have one. You can do so by running pod init in the folder of the project.
2. Add Criollo to your Podfile. pod 'Criollo', '~> 0.1’
3. Run pod install

Please note that Criollo will download CocoaAsyncSocket as a dependency.

Criollo uses CocoaAsyncSocket which is included as a git submodule

git clone --recursive https://github.com/thecatalinstan/Criollo.git

Criollo is work in progress and - as such - it’s not ready for the wild yet. The reason for this is mainly missing functionality and sheer lack of documentation[^It is also very high on my list of priorities, but sadly still a “to-do” item].

The existing APIs are relatively stable and are unlikely to change dramatically unless marked as such.

1. Multipart request body parsing. Criollo can handle JSON and URL-encoded bodies for now. Upcoming and in progress is the multipart/form-data request parsing.
2. Binary / MIME body. Requests that send binary data completely ignore this for now. This implementation is on the way, right after multipart.
3. HTTPS - The workaround for this is putting your app behind a web server, like Nginx, and using the web-server as a reverse HTTP proxy or FastCGI client. Here’s an example of how to setup nginx to reverse proxy HTTP requests and here’s how to set up FastCGI.

If you have any questions regarding the project or how to do anything with it, please feel free to get in touch either on Twitter @criolloio or by plain old email [email protected].

I really encourage you to submit an issue, as your input is really and truly appreciated.