Updated README.md

This commit is contained in:
2021-02-28 00:44:43 +11:00
parent ea19cb0b03
commit 34a5444705
+33 -18
View File
@@ -27,11 +27,40 @@ docker-compose up --build
There are external components to this template referred to as "microservices". These can be omitted entirely by simply removing the React component that accesses them. There are external components to this template referred to as "microservices". These can be omitted entirely by simply removing the React component that accesses them.
* News Server: https://github.com/krgamestudios/news-server * News Server: https://github.com/krgamestudios/news-server
* Chat Server: Coming soon... * Chat Server: https://github.com/krgamestudios/chat-server
# TODO list # TODO list
- ~~Legal Requirements:~~ - Account system
- A separate user settings page
- Administration Panel
- inspect aggregate user data
- Moderation tools for banning, suspending, or chat-banning users
- Chat system (microservice)
- Based on usernames
- Chat logs
- Custom emoji
- Moderation tools
- Global chat channels
- User-created chat channels with an invite/search system
- Private messages
- Icons/roles next to username
- Better compression for client files
- Some form of bot/alt account detection?
- A payment system
- Backend for trading and leaderboards
- Server-side actions to allow offline progress or progress on spotty internet connections
- Full tutorial for setting up and using the site
- Start here page
- Security holes
- HTTPS
- Default admin account
- Information about legal requirements of the developers using this template
- Privacy policy & data collection notices
# DONE list
- Legal Requirements:
- ~~Physical Mailing Address Config (for emails)~~ - ~~Physical Mailing Address Config (for emails)~~
- ~~Opt-out option (for emails)~~ - ~~Opt-out option (for emails)~~
- ~~Privacy policy & data collection notices~~ - ~~Privacy policy & data collection notices~~
@@ -47,28 +76,14 @@ There are external components to this template referred to as "microservices". T
- Administration Panel - Administration Panel
- ~~Default admin account~~ - ~~Default admin account~~
- ~~Exclusive to admin accounts~~ - ~~Exclusive to admin accounts~~
- inspect aggregate user data - News blog system (microservice)
- ~~News blog system (microservice)~~
- ~~build the microservice to provide the news feed~~ - ~~build the microservice to provide the news feed~~
- ~~access an external news feed~~ - ~~access an external news feed~~
- ~~admin panel for publishing and editing news~~ - ~~admin panel for publishing and editing news~~
- ~~"created at" and "updated at" in the response~~ - ~~"created at" and "updated at" in the response~~
- Chat system (microservice) - Configuraton Script:
- Based on usernames
- Chat logs
- Direct Messages & rooms
- admin panel banning/unbanning (currently borked)
- ~~Configuraton Script:~~
- ~~Default UUID keys~~ - ~~Default UUID keys~~
- ~~Docker, docker, docker.~~ - ~~Docker, docker, docker.~~
- Better compression for client files
- Full tutorial for setting up and using the site
- Start here page
- Security holes
- HTTPS
- Default admin account
- Information about legal requirements of the developers using this template
- Privacy policy & data collection notices
# Email settings # Email settings