70 lines
1.6 KiB
Markdown
70 lines
1.6 KiB
Markdown
[](http://kemalcr.com)
|
|
|
|
# Kemal
|
|
|
|
Lightning Fast, Super Simple web framework.
|
|
|
|
**THIS IS A FORK OF KEMAL. DIRECT TO FORK.MD FOR SPECIFICS ON THIS FORK.**
|
|
|
|
[](https://github.com/kemalcr/kemal/actions/workflows/ci.yml)
|
|
[](https://gitter.im/sdogruyol/kemal?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
# Super Simple ⚡️
|
|
|
|
```ruby
|
|
require "kemal"
|
|
|
|
# Matches GET "http://host:port/"
|
|
get "/" do
|
|
"Hello World!"
|
|
end
|
|
|
|
# Creates a WebSocket handler.
|
|
# Matches "ws://host:port/socket"
|
|
ws "/socket" do |socket|
|
|
socket.send "Hello from Kemal!"
|
|
end
|
|
|
|
Kemal.run
|
|
```
|
|
|
|
Start your application!
|
|
|
|
```
|
|
crystal src/kemal_sample.cr
|
|
```
|
|
|
|
Go to _http://localhost:3000_
|
|
|
|
Check [documentation](http://kemalcr.com) or [samples](https://github.com/kemalcr/kemal/tree/master/samples) for more.
|
|
|
|
# Installation
|
|
|
|
Add this to your application's `shard.yml`:
|
|
|
|
```yaml
|
|
dependencies:
|
|
kemal:
|
|
github: kemalcr/kemal
|
|
```
|
|
|
|
See also [Getting Started](http://kemalcr.com/guide/).
|
|
|
|
# Features
|
|
|
|
- Support all REST verbs
|
|
- Websocket support
|
|
- Request/Response context, easy parameter handling
|
|
- Middleware support
|
|
- Built-in JSON support
|
|
- Built-in static file serving
|
|
- Built-in view templating via [ECR](https://crystal-lang.org/api/ECR.html)
|
|
|
|
# Documentation
|
|
|
|
You can read the documentation at the official site [kemalcr.com](http://kemalcr.com)
|
|
|
|
## Thanks
|
|
|
|
Thanks to Manas for their awesome work on [Frank](https://github.com/manastech/frank).
|