Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pkoretic/recurse
Qt based micro web framework with middleware design
https://github.com/pkoretic/recurse
cpp micro-framework qt server web-framework
Last synced: 6 days ago
JSON representation
Qt based micro web framework with middleware design
- Host: GitHub
- URL: https://github.com/pkoretic/recurse
- Owner: pkoretic
- License: mit
- Created: 2015-06-01T19:11:17.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-23T14:41:43.000Z (almost 8 years ago)
- Last Synced: 2024-04-14T22:56:01.427Z (7 months ago)
- Topics: cpp, micro-framework, qt, server, web-framework
- Language: C++
- Size: 186 KB
- Stars: 20
- Watchers: 6
- Forks: 3
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [
](https://github.com/qaap/recurse.git)
[](https://github.com/qaap/recurse/blob/master/LICENSE)
[](http://en.cppreference.com/w/cpp/language)
Recurse is set to be a modern web micro framework written in latest C++ (14) using
Qt library leveraging all the best features of both worlds. We strongly
emphasize on writing a clean and easy to understand code and avoid using
templates to encourage contributions.
Recurse aims to be small with no middlewares bundled in the core. This should
allow it to be very robust for writing next generation web applications and
APIs.
It is inspired by [Node.js](https://nodejs.org/en) [koa](http://koajs.com) and [Express](http://expressjs.com) micro frameworks.
## Example
```
#include "recurse.hpp"
int main(int argc, char *argv[])
{
Recurse app(argc, argv);
// logger
app.use([](auto &ctx, auto next)
{
qDebug() << ctx.request.ip;
next();
});
// hello world
app.use([](auto &ctx)
{
ctx.response.send("Hello world");
});
app.listen(3000);
};
```
## Installation
This is a header-only library. To use, just include `recurse.hpp` inside your project. See
[examples](examples) for more information.
**`NOTE`** you also need `context.hpp`, `request.hpp`, `response.hpp` as `recurse.hpp` depends on
them.
## Middlewares
There is no middleware bundled in the core.
For example, for routing, one can use [Router](https://github.com/qaap/recurse-router)
```
#include "router.hpp"
int main(int argc, char *argv[])
{
Recurse app(argc, argv);
Module::Router router;
router.GET("/hello/:user", [](auto &ctx, auto /* next */)
{
ctx.response.send("Hello World " + ctx.request.params["user"]);
});
app.listen();
}
```
## 404 - Not Found
By default, if no middleware responds, **Recurse** will respond with `Not Found`
message, and `404` HTTP error code.
To make your own response, simply add new middleware at the **end** of the list
```
// if any middleware before this responds this won't get called
app.use([](auto &ctx)
{
ctx.response.status(404).send("Custom Not Found");
});
```
For a complete example see [404 example](https://github.com/qaap/recurse/tree/master/examples/404)
You can also have it as a **first** middleware (if you already have some first
middleware that does your logging or similar)
```
app.use([](auto &ctx, auto next, auto prev)
{
next([&ctx, prev]
{
// this is last code to be called before sending response to client
if(ctx.response.status() == 404)
ctx.response.body("Custom Not Found");
prev();
});
});
```
## Styling
When writing code, please use the provided [.clang-format](https://github.com/qaap/recurse/blob/master/.clang-format) file.
There is a nice [vim-clang-format](https://github.com/rhysd/vim-clang-format) plugin that you can use in vim.
You can also call it manually
```
clang-format -i source.hpp
# to format all files
find . -name "*.hpp" -or -name "*.cpp" | xargs clang-format -i
```
And you can also use shortcut command
```
clang-format -i -style="{BasedOnStyle: WebKit, PointerAlignment: Right, Standard: Cpp11, TabWidth: 4, UseTab: Never, BreakBeforeBraces: Allman, AllowShortFunctionsOnASingleLine: false, ContinuationIndentWidth: 0, MaxEmptyLinesToKeep: 1, NamespaceIndentation: All, AccessModifierOffset: 0}" source.hpp
```