The_Bois/BingoBongo
3
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Compare commits

base: The_Bois:7b4627e4a7935c869ecc90dfc917efb8efca2276
Branches Tags
The_Bois:master
The_Bois:frontend
The_Bois:backend
The_Bois:docs
..
compare: The_Bois:d3b9f811f5c00361604958461c15d9c6ad4e61fd
Branches Tags
The_Bois:frontend
The_Bois:master
The_Bois:backend
The_Bois:docs

No commits in common. "7b4627e4a7935c869ecc90dfc917efb8efca2276" and "d3b9f811f5c00361604958461c15d9c6ad4e61fd" have entirely different histories.
7b4627e4a7 ... d3b9f811f5

1 changed files with 0 additions and 84 deletions
Show Stats Expand all files Collapse all files

84
docs/backend/README.md
View File

@ -1,84 +0,0 @@
# BingoBongo Backend
## JSON API
### Objects
---
BingoSquare
```json
{
"option": "String"
}
```
---
BingoBoard
```json
{
"size": 9,
"squares": [
<BingoSquare>,
<BingoSquare>,
...,
<BingoSquare>
]
}
```
---
Meta
```json
{
"name": "String",
"description": "String"
}
```
---
BingoPool
```json
{
"meta": Meta,
"squares": [
<BingoSquare>,
<BingoSquare>,
...,
<BingoSquare>
]
}
```
## 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