Gitgals/Server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add README.md

Browse Source
This commit is contained in:
Sebastian H. Gabrielli 2023-12-25 15:47:08 +01:00
parent 57191c043e
commit 9d6e27415e
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md Normal file
View File

@ -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
```