diff --git a/README.md b/README.md new file mode 100644 index 0000000..3e5f917 --- /dev/null +++ b/README.md @@ -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 +```