lila-chat/README.md

51 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2021-07-17 15:46:23 +00:00
# Chat Registration System
2021-07-23 14:35:14 +00:00
A simple chat system for built for maya's livestream.
Provides a simple API for user authentication, and chat functions.
Frontend & backend code stored here.
2021-07-17 15:46:23 +00:00
## Implemented Features:
2021-07-17 19:52:52 +00:00
- [x] Basic auth API
2021-07-18 17:26:26 +00:00
- [x] Return json instead of string
- "status" shows wether request was succesful or not, either "ok" or "fail"
- "reason" is for more details, mainly just for debugging?
- [x] Basic messaging system
2021-07-18 15:37:11 +00:00
- [x] Finish up `chat::create_message()`
- [x] Create `chat::fetch_messages()`
- [x] Use unix timestamp for date
- [x] Switch to using sled database to store users
2021-07-23 14:35:14 +00:00
- [x] Error handling
2021-07-18 17:26:26 +00:00
- [x] Token generation & storage
- [x] Sets cookie
- [x] Store token in json
- [x] Have cookie expire
- [x] Remove old cookie
- [x] Use token for most stuff
2021-07-22 18:23:59 +00:00
- [x] Logout API
- [x] Fail on NULL token
2021-07-17 19:52:52 +00:00
- [x] Pronouns
- [x] Set pronouns
2021-07-22 21:17:55 +00:00
- [x] Change pronouns
2021-07-23 14:35:14 +00:00
- [x] make changed_event Enum, use token instead of pin
## To-Do:
- [x] Better messaging system
- [ ] Use websockets for chat [issue#3](https://git.lavender.software/erin/lila-chat/issues/3)
- [ ] Create `chat::delete_message()`
- [ ] Display pronouns [issue#4](https://git.lavender.software/erin/lila-chat/issues/4)
- [ ] Various database improvements [issue#1](https://git.lavender.software/erin/lila-chat/issues/1)
- [ ] Improve error handling on write functions
- [ ] Allow for asyncronous reading/writing
2021-07-18 02:27:05 +00:00
- [ ] Some form of plural support?
2021-07-17 23:41:41 +00:00
- [ ] User management (banning, etc.)
2021-07-22 21:30:06 +00:00
- [x] User roles (admin, mod, etc.)
- [ ] Commands to affect users [issue#2](https://git.lavender.software/erin/lila-chat/issues/2)
2021-07-17 23:41:41 +00:00
- [ ] Blacklist words from chat/names
- [ ] More advanced chat features
2021-07-22 20:20:49 +00:00
- [x] Different types of message events? eg. default, announcement, command
2021-07-22 21:30:06 +00:00
- [ ] Types will display differently? eg. announcements pinned to top?
- [ ] Have different commands?
- [ ] Emote support?