add readme

This commit is contained in:
Sebastian Hugentobler 2022-03-18 19:51:17 +01:00
parent dac95b7dae
commit ad79f4f086
Signed by: shu
GPG Key ID: BB32CF3CA052C2F0

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# vesys bank servers
Implementations of a simple bank server for the 2022 vesys class at FHNW.
Please note that the writer is in no way an experienced or even professional rust developer (hence the cloning everywhere) and
most of this was written in a hurry. Parts of the code might sneak into your house in bright daylight and marry your cat,
to run of with them to Greenland or wherever it is they go for their honeymoon.
## socket-server
Use an on-the-fly invented byte protocol. Consult the code for documentation.
## http-server
An http implementation, using [actix-web](https://actix.rs/), wanted to try that for a while now.
Again, consult the code for information on how the routes work.
# Usage
Run like you would with any [cargo workspace](https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html) project.
For example, starting the http-server variant, with debug logging and compiled in release mode:
```
RUST_LOG=debug cargo run --release --bin http-server
```