Expressed Realms is the digital companion guide for Six Stones - Society in Shadows, a Capstone LARP Systems.
There are two main goals for this project
- Provide a platform to store all the lore, expressions, game mechanics, and other information about the Society
- Provide a platform for creating and maintaining character sheets for the residents of the Society
For a full experience of the application with up-to-date information, please go to https://societyinshadows.org to get started.
Or join our discord group here
An up-to-date list of all broad goals can be found in the Milestones section of the project.
In addition to the quick start below, the high level architecture and technologies can be found here
Before we get started, a bit of a quick disclaimer.
This project was built using the Fedora Operating System, due to some limitations with how the Windows Subsystem for Linux and Docker Desktop work together.
Docker Compose should allow the site to work on windows and linux, but there might need to be some additional setup on the windows side.
Some documentation is provided in area's where there is a difference between operating systems, but it is by no means comprehensive.
Jetbrains Rider is also the primary editor of choice for this project.
After you clone the repo to your local, add the following snippet as an ".env" file to the root of the repo (same folder this readme is in)
Fill in the blanks below, each email / user / password should be filled in
Side Note: Avoid spaces on the right hand side of the values
# pgAdmin is the db management tool.
# These values are your login credentials
PGADMIN_EMAIL=
PGADMIN_PASSWORD=
# This is the db name, plus the user and
# password you need to connect to it
DB_NAME=expressedRealms
DB_USER=
DB_PASSWORD=Next, you need to setup SSL Certs
Once you get docker up and running, add the .env file, and get the SSL certs setup, you should be good to go to start the website.
What you want to do is open up the root of the project (the same directory as this readme) with command line or terminal, and run the following command.
docker compose upAt this point, it will start doing a lot of things all together. If this is the first time running this, it will take time to download all the images, then get things started.
Once the deluge messages cool down, you can visit links below.
Links to various places locally can be found here:
- Front End / Web App
- Back End / Web API / Swagger
- DB Management / pgAdmin
- Feature Flags
- Email Testing
These are stored separate if you would like access, ask about it in the discord group
To get the full experience with all the data, feel free to create a user at https://societyinshadows.org