This project was generated with create-empirica-app.
To run this project locally, run the local server:
meteorYour Empirica experiment is built with Meteor web development framework. All your code will be split in 2 main categories: code running on the client (the browser) and code running on the server. This functional seperation is immediately reflected in the folders structure.
All code in the /client directory will be ran on the client. The entry point
for your app on the client can be found in /client/main.js. In there you will
find more details about how to customize how a game Round should be rendered,
what Consent message and which Intro Steps you want to present the players
with, etc.
The HTML root of you app in /client/main.html shouldn't generally be changed
much, other than to update the app's HTML <head>, which contains the app's
title, and possibly 3rd party JS and CSS imports.
All styling starts in /client/main.less, and is written in
LESS, a simple superset of CSS. You can also add a plain
CSS files in /client.
The /client/game, /client/intro, /client/exit directories all contain
React components, which compose the UI of your app.
If you are new to React, we recommend you try out the official
React Tutorial.
Server-side code all starts in the /server/main.js file. In that file, we set
an important Empirica integration point, the Empirica.gameInit, which allows
to configure each game as they are initiated by Empirica.
From there we import 2 other files. First the /server/callback.js file, which
contains all the possible callbacks used in the lifecycle of a game. These
callbacks, such as onRoundEnd, offer powerful ways to add logic to a game in a
central point (the server), which is often preferable to adding all the logic on
the client.
Finally, the /server/bots.js file is where you can add bot definitions
to your app.
The /public is here to host any static assets you might need in the game, such
as images. For example, if you add an image at /public/my-logo.jpeg, it will
be available in the app at http://localhost:3000/my-logo.jpeg.
We generated a basic settings file (/local.json), which should originally only
contain configuration for admin login. More documentation for settings is coming
soon.
You can run the app with the settings like this:
meteor --settings local.jsonAs new versions of Empirica become available, you might want to update the version you are using in your app. To do so, simply run:
meteor update empirica:core- Empirica Website: https://empirica.ly/
- Meteor Tutorial: https://www.meteor.com/tutorials/react/creating-an-app
- React Tutorial: https://reactjs.org/tutorial/tutorial.html
- LESS Intro: http://lesscss.org/#overview
- JavaScript Tutorial: https://javascript.info/