Updated README.md
This commit is contained in:
@@ -1,3 +1,11 @@
|
|||||||
|
# WARNING
|
||||||
|
|
||||||
|
It's not ready yet.
|
||||||
|
|
||||||
|
There are legal requirements that will cover both KR Game Studios and the developers who use this - I need to address these, still.
|
||||||
|
|
||||||
|
Also, there's a lot of features still missing (see [TODO list](#TODO-list)), and I'm working as hard as I can on this.
|
||||||
|
|
||||||
# MERN-template
|
# MERN-template
|
||||||
|
|
||||||
A website template using the MERN stack.
|
A website template using the MERN stack.
|
||||||
@@ -31,18 +39,23 @@ docker-compose up
|
|||||||
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...
|
||||||
TODO: more info.
|
|
||||||
|
|
||||||
# TODO list
|
# TODO list
|
||||||
|
|
||||||
|
- Legal Requirements:
|
||||||
|
- Physical Mailing Address Config (for emails)
|
||||||
|
- Opt-out option (for emails)
|
||||||
|
- Information about legal requirements of the developers using this template
|
||||||
|
- Privacy policy & data collection notices
|
||||||
|
- LICENSE file
|
||||||
|
- ~~annoying "This site uses cookies" message~~
|
||||||
- ~~Account system~~
|
- ~~Account system~~
|
||||||
- ~~sign up~~
|
- ~~sign up~~
|
||||||
- ~~validate email~~
|
- ~~validate email~~
|
||||||
- ~~login (with cookies)~~
|
- ~~login (with cookies)~~
|
||||||
- ~~logout (with cookies)~~
|
- ~~logout (with cookies)~~
|
||||||
- ~~account deletion~~
|
- ~~account deletion~~
|
||||||
- ~~annoying "This site uses cookies" message~~
|
|
||||||
- Administration Panel
|
- Administration Panel
|
||||||
- ~~Exclusive to admin accounts~~
|
- ~~Exclusive to admin accounts~~
|
||||||
- inspect aggregate user data
|
- inspect aggregate user data
|
||||||
@@ -56,11 +69,10 @@ TODO: more info.
|
|||||||
- Chat logs
|
- Chat logs
|
||||||
- Direct Messages & rooms
|
- Direct Messages & rooms
|
||||||
- admin panel banning/unbanning (currently borked)
|
- admin panel banning/unbanning (currently borked)
|
||||||
- Privacy policy & data collection notice
|
- Configuraton Script:
|
||||||
- configuration script
|
- Default UUID keys
|
||||||
- Docker, docker, docker.
|
- ~~Docker, docker, docker.~~
|
||||||
- Start here page
|
- Start here page
|
||||||
- LICENSE
|
|
||||||
|
|
||||||
# Email settings
|
# Email settings
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user