diff --git a/docs/backend/README.md b/docs/backend/README.md new file mode 100644 index 0000000..6d9c95d --- /dev/null +++ b/docs/backend/README.md @@ -0,0 +1,84 @@ +# BingoBongo Backend + +## JSON API + +### Objects + +--- +BingoSquare +```json +{ + "option": "String" +} +``` +--- +BingoBoard +```json +{ + "size": 9, + "squares": [ + , + , + ..., + + ] +} +``` +--- +Meta +```json +{ + "name": "String", + "description": "String" +} +``` +--- +BingoPool +```json +{ + "meta": Meta, + "squares": [ + , + , + ..., + + ] +} +``` + + +## Config +Config is loaded from `~/.local/bingobongo.toml` + +Config default is: +```toml +working_dir = "/path/to/working/dir" +``` + +## Running +Currently the backend loads the bingo datasets from the `{working_dir}/pools/` directory, they are just toml files with the following syntax + +```toml +[meta] +name = 'Name of pool' +description = 'Description of pool' + +[[squares]] +option = 'First square' + +[[squares]] +option = 'Second square' + +[[squares]] +option = 'Third square' + +[[squares]] +option = 'Fourth square' + +[[squares]] +option = 'Fifth square' +``` + +Having the same header `[[]]` puts them in a list + +Both the config and a single dataset is required \ No newline at end of file