Skip to content

Commit e2f1c95

Browse files
author
Jose Joya
committed
feat: Added Corax template documentation to be part of Crow
1 parent 5a972fe commit e2f1c95

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
This page shows how you can get started with a simple hello world application using corax template.
2+
3+
## 1. Get the template
4+
First, you need to get the corax template. You can do this by downloading the [corax template repository](https://github.com/seobryn/corax-template) as Zip file.
5+
6+
## 2. Unzip the template
7+
Then, you need to unzip the template and rename the folder with your project name, for example, `hello-world` in this case.
8+
9+
## 3. Compile the code
10+
11+
``` bash
12+
cd hello-world
13+
mkdir build
14+
cd scripts && ./make.sh
15+
./compile.sh
16+
cd ../release/bin/ && ./corax
17+
```
18+
19+
After building your `.cpp` file and running the resulting executable, you should be able to access your endpoint at [http://localhost:8081](http://localhost:8081). Opening this URL in your browser will show a white screen with "Hello world" typed on it.
20+
21+
## 4. Change the code
22+
23+
You can change the code in the `src/main.cpp` file to fit your needs.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ nav:
5656
- Windows: getting_started/setup/windows.md
5757
- Your First Application: getting_started/your_first_application.md
5858
- A Simple Webpage: getting_started/a_simple_webpage.md
59+
- Simple Api Using Corax Template: getting_started/simple_api_using_corax_template.md
5960
- Guides:
6061
- Different parts of Crow:
6162
- App: guides/app.md

0 commit comments

Comments
 (0)