-
Notifications
You must be signed in to change notification settings - Fork 4
Home
Dae Houlihan edited this page Apr 10, 2025
·
4 revisions
Welcome to the wiki for the serverless jsPsych template. This template provides a modern development environment for building online psychology experiments using TypeScript, jsPsych, Firebase, and Prolific.
This template combines several key technologies to create a robust development environment:
- TypeScript for type-safe JavaScript development
- Vite for fast, modern bundling
- jsPsych for psychology experiment flow
- TailwindCSS for modern styling
- Firebase/Firestore for serverless backend
- Prolific integration for participant recruitment
- Fork the repository and run experiment locally with the mock database (
simulateMockDatabase = trueinappConfig.ts) - Configure your IDE (VS Code recommended)
- Update info in
appConfig.ts(name, email, etc.) - Build your experiment using jsPsych
- Set up Firebase project and Firestore database
- Add Firebase credentials to
creds.ts - Test with Firestore by setting
simulateMockDatabase = false - When ready, deploy to Firebase
- Test data collection and retrieval in production
- Set up Prolific study and add completion code to
creds.ts - Deploy final experiment version and collect data
- Installation - Setting up your development environment
- Firebase Setup - Configuring Firebase and Firestore
- Development Workflow - Day-to-day development guide
- Deployment Guide - How to deploy your experiment
- Data Collection - Working with Prolific and retrieving data
- Environment Configuration - Understanding different environments (development, testing, production)
- Local Testing Strategies - Structured approaches to testing your experiment
- Troubleshooting Guide - Solutions to common issues
- Tutorial-Getting-Started - Complete walkthrough for beginners
- Tutorial-Firebase-Setup - Step-by-step Firebase setup with screenshots
- Tutorial-Project-Setup - Detailed project setup guide
- Fork this template:
Use this template>Create a new repository - Clone your fork:
git clone https://github.com/YOUR-USERNAME/YOUR-REPO.git - Install dependencies:
yarn install(see Installation for more details) - Start development server:
yarn dev - Open your browser to the URL shown in the terminal (usually
http://localhost:5173)
See the Installation page for detailed setup instructions.