Comment on page
Here is an overview of the files and folders included in every exbuilder project. Click on any top-level file or folder to learn more.
analysesdirectory includes two sample analysis folders:
analysisfolder is mapped to the
workfolder inside your project's
jupytercontainers so work you do in the containers will be saved on your local machine. Learn more about doing your analyses in the exbuilder framework on the Analyses page. You can rename the
analysesdirectory provided you tell exbuilder via the
ANALYSES_DIRECTORYvariable in your
databasedirectory includes the
init.sqlfile, which You can rename the
databasedirectory provided you tell exbuilder via the
DATABASE_DIRECTORYvariable in your
experiment2-jspsych-recordaudio) demonstrating how to use exbuilder with web experiments, including exbuilder's audio recording object ExbuilderRecordAudio. The
index.htmlfile is a landing page for exbuilder's webserver, helping you to generate URL variables for your experiments, and
config-exbuilder.json, a configuration file in which you can customize some things about your landing page. More details are available on the Experiments page. The
experimentsfolder is mapped to the
/var/www/htmlfolder inside your project's
nginxcontainer. You can rename the
experimentsdirectory provided you tell exbuilder via the
EXPERIMENTS_DIRECTORYvariable in your
preregistrationdirectory is a placeholder for preregistrations and comes with
readme.md, a document with some suggestions for how to preregister. You can rename this directory or delete it if you don't need it.
.env.samplefile is a sample
.envfiles are used to tell exbuilder about the environment it is running in, like your local computer.
.envfiles can contain sensitive information like database passwords, so exbuilder is setup to ignore
.envfiles in version control (see
.gitignore). Learn more about configuring your environment on the Configure Environment page.
.gitignorefile tells git to ignore files or folders that should not be tracked or committed to your project repository. exbuilder comes with a
.gitignorefile setup to ignore just a few system files, log files, and environment files. You can add to this file if you want or need to.
docker-compose.deploy.ymlfile tells docker to build your project's
phpcontainers) and to join the
exbuilder_deployerdocker network. It is used to deploy your exbuilder experiments to your own cloud server for data collection. Learn more about deploying your exbuilder experiments on the Deployment page.
docker-compose.ymlfile tells docker how to build exbuilder's fleet of docker containers:
docker-compose.ymlfile is used for developing web experiments and analyzing data locally, as well as sharing your work with others.
LICENSEfile includes exbuilder's license. You may wish to delete this file and select a different license if you choose to share your project publically.
README.mdfile describes exbuilder breifly. We recommend modifying this file to describe to others (or your future self) how to start your project's containers. We've provided some sample language on the sample readme file page.