diff --git a/README.md b/README.md new file mode 100644 index 0000000..da37041 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Rocket server test +This is a test of a webserver honoring the sample OmegaV V2 members API. + +## File structure +``` +├── Cargo.toml ................... Dependencies +├── README.md ................... This file :D +├── src .......................... Source files +│   ├── database.rs .............. Database connection +│   ├── main.rs .................. Running the webserver and attaching the endpoints +│   ├── models ................... Define the structs, both custom ones and DB ones +│   │   ├── entities ............. DB Structs, generated by SeaORM +│   │   │   ├── members.rs +│   │   │   ├── mod.rs +│   │   │   ├── prelude.rs +│   │   │   └── rfid_cards.rs +│   │   ├── member.rs ............ My custom structs relating to member functionality +│   │   └── mod.rs ............... Allow for importing using the `mod` keyword +│   └── webserver_member.rs ...... The webserver functions relating to the member functionality +``` \ No newline at end of file