![Crow logo](http://i.imgur.com/wqivvjK.jpg) Crow is C++ microframework for web. (inspired by Python Flask) [![Travis Build](https://travis-ci.org/mrozigor/crow.svg?branch=master)](https://travis-ci.org/mrozigor/crow) [![Coverage Status](https://coveralls.io/repos/github/mrozigor/crow/badge.svg?branch=master)](https://coveralls.io/github/mrozigor/crow?branch=master) [![Gitter](https://badges.gitter.im/crowfork/community.svg)](https://gitter.im/crowfork/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) ```c++ #include "crow.h" int main() { crow::SimpleApp app; CROW_ROUTE(app, "/")([](){ return "Hello world"; }); app.port(18080).multithreaded().run(); } ``` ## Features - Easy routing - Similiar to Flask - Type-safe Handlers (see Example) - Very Fast - ![Benchmark Result in one chart](https://docs.google.com/spreadsheets/d/1KidO9XpuwCRZ2p_JRDJj2aep61H8Sh_KDOhApizv4LE/pubchart?oid=2041467789&format=image) - More data on [crow-benchmark](https://github.com/ipkn/crow-benchmark) - Fast built-in JSON parser (crow::json) - You can also use [json11](https://github.com/dropbox/json11) or [rapidjson](https://github.com/miloyip/rapidjson) for better speed or readability - [Mustache](http://mustache.github.io/) based templating library (crow::mustache) - Header only - All-in-one header file available - Middleware support - Websocket support ## Still in development - ~~Built-in ORM~~ - Check [sqlpp11](https://github.com/rbock/sqlpp11) if you want one. ## Examples #### JSON Response ```c++ CROW_ROUTE(app, "/json") ([]{ crow::json::wvalue x; x["message"] = "Hello, World!"; return x; }); ``` #### Arguments ```c++ CROW_ROUTE(app,"/hello/") ([](int count){ if (count > 100) return crow::response(400); std::ostringstream os; os << count << " bottles of beer!"; return crow::response(os.str()); }); ``` Handler arguments type check at compile time ```c++ // Compile error with message "Handler type is mismatched with URL paramters" CROW_ROUTE(app,"/another/") ([](int a, int b){ return crow::response(500); }); ``` #### Handling JSON Requests ```c++ CROW_ROUTE(app, "/add_json") .methods("POST"_method) ([](const crow::request& req){ auto x = crow::json::load(req.body); if (!x) return crow::response(400); int sum = x["a"].i()+x["b"].i(); std::ostringstream os; os << sum; return crow::response{os.str()}; }); ``` ## How to Build If you just want to use crow, generate `crow_all.h` (use script `amalgamate/merge_all.py`) and include it. ### Requirements - C++ compiler with good C++14 support (tested with g++>=8). - boost 1.7 library. - (optional) CMake to build tests and/or examples. - (optional) Linking with tcmalloc/jemalloc is recommended for speed. ### Building (Tests, Examples) Out-of-source build with CMake is recommended. ``` mkdir build cd build cmake .. make ``` You can run tests with following commands: ``` ctest ``` ### Installing missing dependencies #### Ubuntu sudo apt-get install build-essential libtcmalloc-minimal4 && sudo ln -s /usr/lib/libtcmalloc_minimal.so.4 /usr/lib/libtcmalloc_minimal.so #### OSX brew install boost google-perftools ### Attributions Crow uses the following libraries. http-parser https://github.com/nodejs/http-parser http_parser.c is based on src/http/ngx_http_parse.c from NGINX copyright Igor Sysoev. Additional changes are licensed under the same terms as NGINX and copyright Joyent, Inc. and other Node contributors. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. qs_parse https://github.com/bartgrantham/qs_parse Copyright (c) 2010 Bart Grantham Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. TinySHA1 https://github.com/mohaps/TinySHA1 TinySHA1 - a header only implementation of the SHA1 algorithm. Based on the implementation in boost::uuid::details Copyright (c) 2012-22 SAURAV MOHAPATRA mohaps@gmail.com Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.