Skip to content

Latest commit

 

History

History
123 lines (88 loc) · 2.79 KB

README.md

File metadata and controls

123 lines (88 loc) · 2.79 KB
Raw

C4Web

C for Web is a simple framework for developing Web Applications using C.

Note: Project is at initial development phase, 
code / methods might change without notice.
Please use with caution!

1. Overview

  • Multi Threaded
  • Very Low Dependency
  • Web-Routing Supported
  • Compression Supported ( Zlib )
  • Rich HTTP API
  • Custom Header
  • Works on both Unix and Windows

2. Usage

2.1. Generating Project

First download or clone this repository in your development environment. Use cmake to generate project on your preffered IDE. We recommend using Code::Blocks

Open terminal inside the directory or use cd to navigate.

mkdir cb_project
cd cb_project
cmake -G"CodeBlocks - Unix Makefiles" ..

For other IDE please refer to this guide. Alternatively you can refer to this Issue Page.

2.2. Generating Builds

If you want to skip generating project files, you may use cmake to generate build files. For that use the following commands.

mkdir build
cd build
cmake ..
make

This will create an executable file in your build folder. If you are on Unix system, you may run it by

./c4web

CMake will by default build Debug builds. If you want Release or Minified Release builds please use the following commands.

cmake -DCMAKE_BUILD_TYPE=MinSizeRel ..
make clean
make

3. Examples

3.1. Hello World

#include "framework/c4web.h"

void hello_world(http_request request);

int main(){
    start_server(7071);
    return 0;
}

void router(http_request request){
    if(router_match(request, "hello-world")){
        hello_world(request);
    }
}

void hello_world(http_request request){
    char sample_response[12] = "Hello World";
    http_send_text(request, sample_response);
}

Upcoming

  • E-Tag for Files
  • PCRE ( Regular Expression )
  • GET / POST / Query Processing

Copyright

C4Web is licensed under the GNU General Public License v3.0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Copyright © 2019 Arman Hossain