Mirror/Crow
1
0
Fork 0
mirror of https://github.com/CrowCpp/Crow.git synced 2024-06-07 21:10:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #73 from CrowCpp/moredocs

Browse Source 
Updated all URLs for migration and to fix mkdocs
This commit is contained in:
Farook Al-Sammarraie 2020-12-01 00:07:43 +03:00 committed by GitHub
commit 7d9e64a278
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 35 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.travis.yml
View File

@ -21,8 +21,8 @@ env:
- secure: "CQRYHWlg/WDu5DBUeDwGo+rPeOofN08DhiLUNlLtZjMWaRyP0Cop1qVaFs8ESOkYiWek2MdpvjZud+7hL+yx2ogvNx4SfHpUMCDKYgcX+YQ9MmYwabvoKq8N6KVXE3lbPp549TonHdDuNCWNKRniNjYtrij5J+IiIiT8/6Txo2p9RWk6YSUTdXJ9YrfuWMtRuF5uo9SHGyujv8pOJKedrwWoSBbHT44jnwfHMVe/C8jgjwlrJ9N3iXOtsG6sj+UTS8vOpL+jpBONEbBfHgSFU57I7IFNdPQbSObpVwG9geOAHT7IQQyQ9hp2AJoFxxVURB5SzqztDDpQ0XIF76vuH9tA/fF2pwDsLRmcLR8JU1TCmQgvnlYD0+Or9S1Dq0tQME5AP+21Hk2zVcGdbgQP7XWix758F0vpOXa4PXw8TmAjP2jKyAMHlzR3icr3+OmKSK3uXMMt2HSMOJQ+JvFxr//DM493i/VGyeY25/zu3A9RstiE+1d82Fi9xKOmMf4smvSkjOgT0b727jqNbNe6CvEKQUmqHabzYRQzUVz6WPVDHBxZP7AiKmZIVQXYnDsVXywStkSoxxY5En6XKpq0GR3bIVtUMORgZPoZi7Jni+/4EckcYH8g9mpsQf9tPRcOZ2WIvt5gqp2MZuwBLBRcbxihuECfBscqdeA0oDU5AZw=" - secure: "CQRYHWlg/WDu5DBUeDwGo+rPeOofN08DhiLUNlLtZjMWaRyP0Cop1qVaFs8ESOkYiWek2MdpvjZud+7hL+yx2ogvNx4SfHpUMCDKYgcX+YQ9MmYwabvoKq8N6KVXE3lbPp549TonHdDuNCWNKRniNjYtrij5J+IiIiT8/6Txo2p9RWk6YSUTdXJ9YrfuWMtRuF5uo9SHGyujv8pOJKedrwWoSBbHT44jnwfHMVe/C8jgjwlrJ9N3iXOtsG6sj+UTS8vOpL+jpBONEbBfHgSFU57I7IFNdPQbSObpVwG9geOAHT7IQQyQ9hp2AJoFxxVURB5SzqztDDpQ0XIF76vuH9tA/fF2pwDsLRmcLR8JU1TCmQgvnlYD0+Or9S1Dq0tQME5AP+21Hk2zVcGdbgQP7XWix758F0vpOXa4PXw8TmAjP2jKyAMHlzR3icr3+OmKSK3uXMMt2HSMOJQ+JvFxr//DM493i/VGyeY25/zu3A9RstiE+1d82Fi9xKOmMf4smvSkjOgT0b727jqNbNe6CvEKQUmqHabzYRQzUVz6WPVDHBxZP7AiKmZIVQXYnDsVXywStkSoxxY5En6XKpq0GR3bIVtUMORgZPoZi7Jni+/4EckcYH8g9mpsQf9tPRcOZ2WIvt5gqp2MZuwBLBRcbxihuECfBscqdeA0oDU5AZw="
- GH_REPO_NAME: crow - GH_REPO_NAME: crow
- DOXYFILE: $TRAVIS_BUILD_DIR/Doxyfile - DOXYFILE: $TRAVIS_BUILD_DIR/Doxyfile
- GH_REPO_REF: github.com/mrozigor/crow.git - GH_REPO_REF: github.com/crowcpp/crow.git
- THEME_REPO_REF: github.com/mrozigor/darxygen.git - THEME_REPO_REF: github.com/crowcpp/darxygen.git
addons: addons:

14
README.md
View File

@ -2,9 +2,9 @@
<h4 align="center">A Fast and Easy to use microframework for the web.</h4> <h4 align="center">A Fast and Easy to use microframework for the web.</h4>
<p align="center"> <p align="center">
<a href="https://travis-ci.com/mrozigor/crow"><img src="https://travis-ci.com/mrozigor/crow.svg?branch=master" alt="Build Status"></a> <a href="https://travis-ci.com/crowcpp/crow"><img src="https://travis-ci.com/crowcpp/crow.svg?branch=master" alt="Build Status"></a>
<a href="https://coveralls.io/github/mrozigor/crow?branch=master"><img src="https://coveralls.io/repos/github/mrozigor/crow/badge.svg?branch=master" alt="Coverage Status"></a> <a href="https://coveralls.io/github/crowcpp/crow?branch=master"><img src="https://coveralls.io/repos/github/crowcpp/crow/badge.svg?branch=master" alt="Coverage Status"></a>
<a href="https://mrozigor.github.io/crow"><img src="https://img.shields.io/badge/-Documentation-informational" alt="Documentation"></a> <a href="https://crowcpp.github.io/crow"><img src="https://img.shields.io/badge/-Documentation-informational" alt="Documentation"></a>
<a href="https://gitter.im/crowfork/community?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/crowfork/community.svg" alt="Gitter"></a> <a href="https://gitter.im/crowfork/community?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/crowfork/community.svg" alt="Gitter"></a>
</p> </p>
@ -26,10 +26,10 @@ Crow is a C++ microframework for running web services. It uses routing similar t
- Uses modern C++ (11/14) - Uses modern C++ (11/14)
### Still in development ### Still in development
- [HTTP/2 support](https://github.com/mrozigor/crow/issues/8) - [HTTP/2 support](https://github.com/crowcpp/crow/issues/8)
## Documentation ## Documentation
Available [here](https://mrozigor.github.io/crow). Available [here](https://crowcpp.github.io/crow).
## Examples ## Examples
@ -94,10 +94,10 @@ CROW_ROUTE(app, "/add_json")
}); });
``` ```
More examples can be found [here](https://github.com/mrozigor/crow/tree/master/examples). More examples can be found [here](https://github.com/crowcpp/crow/tree/master/examples).
## Setting Up / Building ## Setting Up / Building
Available [here](https://mrozigor.github.io/crow/getting_started/setup). Available [here](https://crowcpp.github.io/crow/getting_started/setup).
### Attributions ### Attributions

2
docs/getting_started/setup.md
View File

@ -20,7 +20,7 @@ This page explains how to set Crow up for use with your project.
Download boost from [here](https://www.boost.org/) and install it Download boost from [here](https://www.boost.org/) and install it
##Downloading ##Downloading
Either run `git clone https://github.com/mrozigor/crow.git` or download `crow_all.h` from the releases section. You can also download a zip of the project on github. Either run `git clone https://github.com/crowcpp/crow.git` or download `crow_all.h` from the releases section. You can also download a zip of the project on github.
##Includes folder ##Includes folder
1. Copy the `/includes` folder to your project's root folder. 1. Copy the `/includes` folder to your project's root folder.

4
docs/getting_started/your_first_application.md
View File

@ -12,7 +12,7 @@ int main()
} }
``` ```
The App (or SimpleApp) class organizes all the different parts of Crow and provides the developer (you) a simple interface to interact with these parts. The App (or SimpleApp) class organizes all the different parts of Crow and provides the developer (you) a simple interface to interact with these parts.
For more information, please go [here](/guides/app). For more information, please go [here](../../guides/app).
##3. Adding routes ##3. Adding routes
Once you have your app, the next step is to add routes (or endpoints). You can do so with the `CROW_ROUTE` macro. Once you have your app, the next step is to add routes (or endpoints). You can do so with the `CROW_ROUTE` macro.
@ -21,7 +21,7 @@ CROW_ROUTE(app, "/")([](){
return "Hello world"; return "Hello world";
}); });
``` ```
For more details on routes, please go [here](/guides/routes). For more details on routes, please go [here](../../guides/routes).
#4. Running the app #4. Running the app
Once you're happy with how you defined all your routes, you're going to want to instruct Crow to run your app. This is done using the `run()` method. Once you're happy with how you defined all your routes, you're going to want to instruct Crow to run your app. This is done using the `run()` method.

4
docs/guides/app.md
View File

@ -25,5 +25,5 @@ app.bindaddr(192.168.1.2)
``` ```
<br><br> <br><br>
For more info on middlewares, check out [this page](/guides/middleware).<br><br> For more info on middlewares, check out [this page](../middleware).<br><br>
For more info on what functions are available to a Crow app, go [here](/reference/classcrow_1_1_crow.html). For more info on what functions are available to a Crow app, go [here](../../reference/classcrow_1_1_crow.html).

4
docs/guides/json.md
View File

@ -24,6 +24,6 @@ The types of values that `wvalue` can take are as follows:<br>
- `Object`: from type `crow::json::wvalue`.<br> - `Object`: from type `crow::json::wvalue`.<br>
This last type means that `wvalue` can have keys, this is done by simply assigning a value to whatever string key you like, something like `#!cpp wval["key1"] = val1;`. Keep in mind that val1 can be any of the above types.<br><br> This last type means that `wvalue` can have keys, this is done by simply assigning a value to whatever string key you like, something like `#!cpp wval["key1"] = val1;`. Keep in mind that val1 can be any of the above types.<br><br>
A JSON wvalue can be returned directly inside a route handler, this will cause the `content-type` header to automatically be set to `Application/json` and the JSON value will be converted to string and placed in the response body. For more information go to [Routes](/guides/routes).<br><br> A JSON wvalue can be returned directly inside a route handler, this will cause the `content-type` header to automatically be set to `Application/json` and the JSON value will be converted to string and placed in the response body. For more information go to [Routes](../routes).<br><br>
For more info on write values go [here](/reference/classcrow_1_1json_1_1wvalue.html). For more info on write values go [here](../../reference/classcrow_1_1json_1_1wvalue.html).

2
docs/guides/multipart.md
View File

@ -17,4 +17,4 @@ A message can be created either by defining the headers, boundary, and individua
Once a multipart message has been made, the individual parts can be accessed throught `mpmes.parts`, `parts` is an `std::vector`, so accessing the individual parts should be straightforward.<br> Once a multipart message has been made, the individual parts can be accessed throught `mpmes.parts`, `parts` is an `std::vector`, so accessing the individual parts should be straightforward.<br>
In order to access the individual part's name or filename, something like `#!cpp mpmes.parts[0].headers[0].params["name"]` sould do the trick.<br><br> In order to access the individual part's name or filename, something like `#!cpp mpmes.parts[0].headers[0].params["name"]` sould do the trick.<br><br>
For more info on Multipart messages, go [here](/reference/namespacecrow_1_1multipart.html) For more info on Multipart messages, go [here](../../reference/namespacecrow_1_1multipart.html)

6
docs/guides/routes.md
View File

@ -27,7 +27,7 @@ Handlers can also use information from the request by adding it as a parameter `
You can also access the url parameters in the handler using `#!cpp req.url_params.get("param_name");`. If the parameter doesn't exist, `nullptr` is returned.<br><br> You can also access the url parameters in the handler using `#!cpp req.url_params.get("param_name");`. If the parameter doesn't exist, `nullptr` is returned.<br><br>
For more information on `crow::request` go [here](/reference/structcrow_1_1request.html).<br><br> For more information on `crow::request` go [here](../../reference/structcrow_1_1request.html).<br><br>
###Response ###Response
Crow also provides the ability to define a response in the parameters by using `#!cpp ([](const crow::request& req, crow::response& res){...})`.<br> Crow also provides the ability to define a response in the parameters by using `#!cpp ([](const crow::request& req, crow::response& res){...})`.<br>
@ -37,9 +37,9 @@ Please note that in order to return a response defined as a parameter you'll nee
Alternatively, you can define the response in the body and return it (`#!cpp ([](){return crow::response()})`).<br> Alternatively, you can define the response in the body and return it (`#!cpp ([](){return crow::response()})`).<br>
For more information on `crow::response` go [here](/reference/structcrow_1_1response.html).<br><br> For more information on `crow::response` go [here](../../reference/structcrow_1_1response.html).<br><br>
###return statement ###return statement
A `crow::response` is very strictly tied to a route. If you can have something in a response constructor, you can return it in a handler.<br><br> A `crow::response` is very strictly tied to a route. If you can have something in a response constructor, you can return it in a handler.<br><br>
The main return type is `std::string`. although you could also return a `crow::json::wvalue` directly. ***(Support for more data types including third party libraries is coming soon)***<br><br> The main return type is `std::string`. although you could also return a `crow::json::wvalue` directly. ***(Support for more data types including third party libraries is coming soon)***<br><br>
For more information on the specific constructors for a `crow::response` go [here](/reference/structcrow_1_1response.html). For more information on the specific constructors for a `crow::response` go [here](../../reference/structcrow_1_1response.html).

2
docs/guides/syste.md
View File

@ -1 +1,3 @@
https://www.howtogeek.com/687970/how-to-run-a-linux-program-at-startup-with-systemd/ https://www.howtogeek.com/687970/how-to-run-a-linux-program-at-startup-with-systemd/
***HELP NEEDED***

2
docs/guides/templating.md
View File

@ -15,7 +15,7 @@ The HTML page (including the mustache tags). It is usually loaded into `crow::mu
For more information on how to formulate a template, see [this mustache manual](http://mustache.github.io/mustache.5.html). For more information on how to formulate a template, see [this mustache manual](http://mustache.github.io/mustache.5.html).
###Context ###Context
A JSON object containing the tags as keys and their values. `crow::mustache::context` is actually a [crow::json::wvalue](/guides/json#wvalue). A JSON object containing the tags as keys and their values. `crow::mustache::context` is actually a [crow::json::wvalue](../json#wvalue).
##Returning a template ##Returning a template
To return a mustache template, you need to load a page using `#!cpp auto page = crow::mustache::load("path/to/template.html");`, keep in mind that the path is relative to the templates directory.<br> To return a mustache template, you need to load a page using `#!cpp auto page = crow::mustache::load("path/to/template.html");`, keep in mind that the path is relative to the templates directory.<br>

2
docs/guides/websockets.md
View File

@ -28,4 +28,4 @@ CROW_ROUTE(app, "/ws")
}); });
``` ```
<br><br> <br><br>
For more info go [here](/reference/classcrow_1_1_web_socket_rule.html). For more info go [here](../../reference/classcrow_1_1_web_socket_rule.html).

14
docs/index.md
View File

@ -3,9 +3,9 @@
<h4 align="center">A Fast and Easy to use microframework for the web.</h4> <h4 align="center">A Fast and Easy to use microframework for the web.</h4>
<p align="center"> <p align="center">
<a href="https://travis-ci.com/mrozigor/crow"><img src="https://travis-ci.com/mrozigor/crow.svg?branch=master" alt="Build Status"></a> <a href="https://travis-ci.com/crowcpp/crow"><img src="https://travis-ci.com/crowcpp/crow.svg?branch=master" alt="Build Status"></a>
<a href="https://coveralls.io/github/mrozigor/crow?branch=master"><img src="https://coveralls.io/repos/github/mrozigor/crow/badge.svg?branch=master" alt="Coverage Status"></a> <a href="https://coveralls.io/github/crowcpp/crow?branch=master"><img src="https://coveralls.io/repos/github/crowcpp/crow/badge.svg?branch=master" alt="Coverage Status"></a>
<a href="https://mrozigor.github.io/crow"><img src="https://img.shields.io/badge/-Documentation-informational" alt="Documentation"></a> <a href="https://crowcpp.github.io/crow"><img src="https://img.shields.io/badge/-Documentation-informational" alt="Documentation"></a>
<a href="https://gitter.im/crowfork/community?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/crowfork/community.svg" alt="Gitter"></a> <a href="https://gitter.im/crowfork/community?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/crowfork/community.svg" alt="Gitter"></a>
</p> </p>
@ -27,10 +27,10 @@ Crow is a C++ microframework for running web services. It uses routing similar t
- Uses modern C++ (11/14) - Uses modern C++ (11/14)
### Still in development ### Still in development
- [HTTP/2 support](https://github.com/mrozigor/crow/issues/8) - [HTTP/2 support](https://github.com/crowcpp/crow/issues/8)
## Documentation ## Documentation
Available [here](https://mrozigor.github.io/crow). Available [here](https://crowcpp.github.io/crow).
## Examples ## Examples
@ -95,7 +95,7 @@ CROW_ROUTE(app, "/add_json")
}); });
``` ```
More examples can be found [here](https://github.com/mrozigor/crow/tree/master/examples). More examples can be found [here](https://github.com/crowcpp/crow/tree/master/examples).
## Setting Up / Building ## Setting Up / Building
Available [here](https://mrozigor.github.io/crow/getting_started/setup). Available [here](https://crowcpp.github.io/crow/getting_started/setup).

8
mkdocs.yml
View File

@ -1,9 +1,9 @@
site_name: Crow site_name: Crow
# Repository # Repository
repo_name: mrozigor/crow repo_name: crowcpp/crow
repo_url: https://github.com/mrozigor/crow repo_url: https://github.com/crowcpp/crow
site_url: https://mrozigor.github.io/crow site_url: https://crowcpp.github.io/crow
edit_uri: "" edit_uri: ""
theme: theme:
@ -49,7 +49,7 @@ nav:
extra: extra:
social: social:
- icon: fontawesome/brands/github - icon: fontawesome/brands/github
link: https://github.com/mrozigor/crow link: https://github.com/crowcpp/crow
- icon: fontawesome/brands/gitter - icon: fontawesome/brands/gitter
link: https://gitter.im/crowfork/community link: https://gitter.im/crowfork/community