Additional simulation components
Last updated
Last updated
Other components of the platform can also be changed via the environment variables .env file. See the table below for a list and description of these components.
POST_SURVEY
(Optional) The URL to the post-study survey. You may want participants to complete a survey when they have completed the duration of the study.
If yes, define this variable with your survey link. It is shown when the participant tries to log in to the website after their study is complete.
POST_SURVEY_WITH_QUALTRICS
IDENTIFIER
RESEARCHER_EMAIL
NUM_DAYS
Study duration (a numerical value; in # of days). Each day is 24 hours. After this specified number of days has passed since a participant’s account creation, the participant’s account will be deactivated, and they will not be able to access the site after.
COLOR
Background color of platform.
SITE_NAME
Platform Name. This is shown throughout the platform.
SITE_LOGO
File path to the platform logo. This is shown throughout the platform, specifically via the header.
SITE_PICTURE
NUM_EXP_CONDITIONS
The number of experimental conditions in the experiment.
EXP_CONDITIONS_NAMES
The names of the experimental conditions in the experiment. Separate the names with a comma, but no spaces (ex: var1,var2,var3).
FEED_ORDER
Indicates how you would like the feed to be shown. Available values include:
CHRONOLOGICAL: The posts will be shown chronologically on the feed/timeline.
SHUFFLE: The feed posts will be shuffled on the feed/timeline.
CDN
(Optional) CDN URL. A content delivery network (CDN) is a network of interconnected servers that caches content near end users. Using a CDN can speed up webpage loading for data-heavy applications.
In The Truman Platform, a CDN can be used to deliver your actor profile pictures and post pictures.
In the default .env file, a CDN URL is provided, but it is for the default simulation.
Therefore, if you change the simulation content (i.e. define new actors, posts, comments, etc.), you will need to:
Remove this line from the .env file
or
Change the CDN URL to point to the CDN you are personally using to deliver the static content (pictures).
Note: When setting up your CDN, ensure that the bucket that contains your content has a folder ./post_pictures (where all the post pictures are placed in) and a folder ./profile_pictures (where all the profile pictures are placed in).
REMOVE_FLAGGED_CONTENT
TRUE/FALSE
When TRUE, removes flagged content (posts and comments) entirely from timeline. When FALSE, hides flagged content with an overlay and gives participant the option to unflag the content.
These components can be changed in the .env file found in the project folder. It looks like the following when opened with a text file editor:
To change or define a variable, replace the value after the equals sign of the corresponding variable with your desired value.
For example:
If you would like to change the site name to “FootballForums”, then you will need to change the line:
SITE_NAME=eatsnap.love to SITE_NAME=FootballForums
When changing variable names, there should be no spaces between the variable name, equals sign, and variable value. The following will not work because of spacing between the equals sign.
SITE_NAME= FootballForums
SITE_NAME = FootballForums
If your variable value has a space, enclose the value with quotes. For example:
SITE_NAME="Football Forums"
If you'd like to integrate this post-study survey with Qualtrics, see . Remember to append ?r_id= to the end of your survey link and set POST_SURVEY_WITH_QUALTRICS to TRUE.
If no, remove this variable from the .env file by removing the line.
TRUE/FALSE This label indicates if you would like to integrate a Qualtrics post-study survey with your study. See for more information.
Label for participant unique identifier. This label is shown on the form on the Sign Up page. It prompts participants to provide their unique identifier.
The contact email of the researcher. This is shown on the Forgot Your Password page so that participants' may contact you. See for more information on what to do if a participant has forgotten their password.
File path to the platform picture. This is shown on the Login and Sign Up.
