craban/README.md

35 lines
1.2 KiB
Markdown
Raw Normal View History

2021-09-12 17:57:42 +01:00
# Craban
2021-09-11 23:32:07 +01:00
2021-09-13 09:09:58 +01:00
Craban is a webapp to manage RolePlaying Games assets like images,
music and maps, easily share them with playesr and use them in games,
and have conversations with the players though an integrated chat.
2021-09-11 23:32:07 +01:00
## Config
2021-09-12 17:59:22 +01:00
Default configuration can be found in the
[craban.yml](./server/craban.yml) file at the root of the repository.
2021-09-11 23:32:07 +01:00
## Roadmap
2021-09-13 09:09:58 +01:00
- [X] Add simple logger everywhere
- [X] Make server start, teardown and block
- [X] Bootstrap webapp
- [X] Embed webapp in server
- [X] Split server and webapp in different folders
- [X] Add modd for easy development forkflow
2021-09-11 23:32:07 +01:00
- [ ] Add webapp make targets
2021-09-13 14:25:01 +01:00
- [X] Add build make target
- [X] Create basic webapp structure and development workflow
2021-09-12 17:57:42 +01:00
- [X] Think of a better name
2021-09-11 23:32:07 +01:00
- [ ] Add email config and communications
- [ ] Add webpush notifications
2021-09-13 11:48:06 +01:00
- [X] Decide on a visual framework to work with (maybe react-material?)
- [ ] Add webapp linter
2021-09-13 11:48:06 +01:00
- [X] Add token and login endpoint
- [X] Add token reading wrapper at the API level
- [X] Add the concept of admin users
2021-09-12 20:57:59 +01:00
- [ ] Add games management endpoints and webapp screens
2021-09-13 11:48:06 +01:00
- [ ] Add chat messages in game
- [ ] Add websocket messages for new chat post
- [ ] Add webpush notification for new chat post