Skip to content

Commit

Permalink
Merge pull request #7 from Yggdrasill501/clean-up
Browse files Browse the repository at this point in the history
Repository clean-up
  • Loading branch information
Yggdrasill501 authored Feb 3, 2024
2 parents 7137991 + 9e546d7 commit 2e90196
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 75 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# How to contribute?

## TODO:
- [ ] Css handling
- [ ] json handling
- [ ] Restfull api
- [ ] enhance examples
30 changes: 11 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The idea is to create a minimalistic framework in c++ and CMake to make it as ea
The framework must handle Servers and Web Sockets.
And be as easy to use and possible with simple download to be used

## How to run
## How to run in C++
To run server just execute [shell script](https://github.com/Yggdrasill501/cimi-web/blob/main/server.sh)
```
server.sh
Expand All @@ -14,7 +14,7 @@ If you're having a struggle running server.sh, remember to give it the correct p
```
chmod +x server.sh
```
## Examples
### Examples
- Simple Server implementation
```c++
//// For Server listening
Expand Down Expand Up @@ -53,28 +53,20 @@ int main() {

- For more Examples check [./examples/](https://github.com/Yggdrasill501/cimi-web/tree/main/examples)

## Import as python package
```zsh
pip install cimi-web
```

```python
import cimi
```

## Motivation
You may ask where is the motivation coming from?
It's coming to understand and to handle the best way how to handle back-end and api development,
and since C/C++ is probably the most abstract way to do it your self.

## Simple Web server
In [Simple Socket](https://github.com/Yggdrasill501/cimi-web/blob/main/simple_websocket/simple_socket.c),
I used simple implementation of server that runs on ***local host port 8000*** message I am web server.
I used also some modules from standard library to make it as easy as possible to implement as showcase a to
reminder how "Cimple" it can be to handle server.

### Run simple socket
Compile using:
```
gcc -o server server.c
```

To execute:
```
./server
```

## BTW
The Motivation of this project was to make it as simple as possible.
Simplicity is always found in minimalism,
Expand Down
50 changes: 0 additions & 50 deletions simple_websocket/server.c

This file was deleted.

6 changes: 0 additions & 6 deletions todo.md

This file was deleted.

0 comments on commit 2e90196

Please sign in to comment.