2015-12-04 11:14:15 +00:00
|
|
|
# Kemal Documentation
|
|
|
|
|
|
2015-12-04 12:06:18 +00:00
|
|
|
This README includes documentation of Kemal, the Crystal Web Framework.
|
2015-12-04 11:14:15 +00:00
|
|
|
|
|
|
|
|
## What is Kemal?
|
|
|
|
|
|
2015-12-05 20:47:18 +00:00
|
|
|
Kemal is a micro web framework written in Crystal language. It's strongly inspired from [Sinatra](www.sinatrarb.com).
|
2015-12-04 11:14:15 +00:00
|
|
|
|
|
|
|
|
## What is Crystal?
|
|
|
|
|
|
|
|
|
|
Crystal is a programming language based on *Ruby* syntax.
|
|
|
|
|
|
|
|
|
|
## Advantages of using Kemal
|
|
|
|
|
|
2015-12-05 20:47:18 +00:00
|
|
|
- Easy to learn and start to develop.
|
2015-12-04 11:14:15 +00:00
|
|
|
- Since it's working on LLVM, it's too fast.
|
2015-12-07 20:03:35 +00:00
|
|
|
- Easy deployment to *Heroku*.
|
2015-12-04 11:14:15 +00:00
|
|
|
|
|
|
|
|
## The Name
|
|
|
|
|
|
2015-12-05 20:47:18 +00:00
|
|
|
Kemal means *Mature, grown up* in Turkish.
|
2015-12-04 11:33:43 +00:00
|
|
|
|
|
|
|
|
## How to start?
|
|
|
|
|
|
2015-12-16 18:32:01 +00:00
|
|
|
- [Getting Started Tutorial](./getting_started.md)
|
|
|
|
|
- [Restful Web Services](./rest.md)
|
|
|
|
|
- [Websockets](./websockets.md)
|
2015-12-06 14:05:16 +00:00
|
|
|
- [Using Dynamic Views](./views.md)
|
2015-12-07 20:03:35 +00:00
|
|
|
- [HTTP Requests and Responses](./http-requests.md)
|
2015-12-04 11:33:43 +00:00
|
|
|
- [Serving Static Files](./statics.md)
|
|
|
|
|
- [Serving JSON API](./json.md)
|
2015-12-16 18:32:01 +00:00
|
|
|
- [Middlewares](./middlewares.md)
|
2015-12-17 09:28:39 +00:00
|
|
|
- [How to connect to Database](https://github.com/sdogruyol/kemal-pg-sample)
|
