Moonbase/qtc-net-server
Moonbase/qtc-net-server
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Alan Moon 2025-07-27 16:57:46 -07:00
parent 10526dea33
commit 0b35f4e55e
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -7,6 +7,9 @@ This is a from scratch SignalR based chat server that has the following features
- Profiles
- Currency
- Stock Market
- Multiplayer Tic-Tac-Toe
- Email Verification
- Profile Cosmetics Store
# How To Build
In order to build, you need the .NET 9 SDK.
@ -16,9 +19,15 @@ In order to build, you need the .NET 9 SDK.
3. Configure And Enjoy!
# Docker Container (Recommended Self-Hosting Solution)
This Server Does Have A Docker Container You Can Create That Contains Your Config And User Content. Please Refer To ``docker-compose.yml``
This Server Does Have A Docker Container You Can Create That Contains Your Config And User Content. Please Refer To `docker-compose.yml`
# JWT Keys
JWT Keys should be generated from scatch and added to your ``docker-compose.yml`` environment variables.
JWT Keys should be generated from scatch and added to your `docker-compose.yml` environment variables.
Anything Can Be Put Here, But For Security, It Should Be Within 32-Characters Long And Should Be Secure. An Example Key Is Provided, And Should Not Be Used In Production.
Anything Can Be Put Here, But For Security, It Should Be Within 32-Characters Long And Should Be Secure. An Example Key Is Provided, And Should Not Be Used In Production.
# .env File
The environment variable file is used to store sensitive info and settings, such as db passwords, keys, etc.
Most things are configured here, however some things are configured in `appsettings.json`
Please refer to `.env.sample` for more info.