# Welcome!

## 🏡 We've moved!

**Please refer to the new Pushkin documentation at** [**https://pushkin-consortium.github.io/pushkin**](https://pushkin-consortium.github.io/pushkin)**!**

***

## Welcome!

“Getting Started” will get a very simple demo site up and running. The remaining pages explain how to customize your website. Instructions are geared towards someone who ideally has at least some familiarity with JavaScript and React. Sections intended for more experienced programmers who need to understand the guts of Pushkin are labeled under Developers. See the full Table of contents [here](#table-of-contents).

To get the latest news and updates on Pushkin, sign up for our newsletter [here](https://groups.google.com/g/pushkinjs)

***

### 🚨 Important Note

> **Due to an update in AWS resources, the CLI-based AWS deploy does not currently work and is being updated. In the meantime, you can still manually deploy to AWS.**

***

### Table of contents

* **Getting Started**
  * [Installing Pushkin and dependencies](https://languagelearninglab.gitbook.io/pushkin/getting-started/installing-pushkin-and-dependencies)
    * [macOS](https://languagelearninglab.gitbook.io/pushkin/getting-started/installing-pushkin-and-dependencies/macos-install)
    * Windows 10
      * [Windows Subsystem for Linux](https://languagelearninglab.gitbook.io/pushkin/getting-started/installing-pushkin-and-dependencies/windows-10/windows-install) (preferred)
      * [AWS EC2 Instance](https://languagelearninglab.gitbook.io/pushkin/getting-started/installing-pushkin-and-dependencies/windows-10/ec2-install)
    * [Ubuntu Linux](https://languagelearninglab.gitbook.io/pushkin/getting-started/installing-pushkin-and-dependencies/ubuntu-install)
  * [Quickstart](https://languagelearninglab.gitbook.io/pushkin/getting-started/quickstart)
  * [Deploying to AWS](https://languagelearninglab.gitbook.io/pushkin/getting-started/deploying-to-aws)
    * [Install required software.](https://languagelearninglab.gitbook.io/pushkin/getting-started/deploying-to-aws/install-required-software)
    * [Configure the AWS and ECS CLIs.](https://languagelearninglab.gitbook.io/pushkin/getting-started/deploying-to-aws/configure-aws-and-ecs-clis)
    * [Register a domain.](https://languagelearninglab.gitbook.io/pushkin/getting-started/deploying-to-aws/domain-registration)
    * [Set up DockerHub.](https://languagelearninglab.gitbook.io/pushkin/getting-started/deploying-to-aws/dockerhub)
    * [Initialize AWS Deploy.](https://languagelearninglab.gitbook.io/pushkin/getting-started/deploying-to-aws/initializing-aws-deploy)
  * [Tutorial: Simple Experiment](https://languagelearninglab.gitbook.io/pushkin/getting-started/tutorial-simple-experiment)
* **FAQ**
  * [FAQ](https://languagelearninglab.gitbook.io/pushkin/faq/faq)
* **Advanced**
  * [Pushkin CLI](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-cli)
    * [config](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-cli#config)
    * [install site](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-cli#install-site)
    * [install experiment](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-cli#install-experiment)
    * [updateDB](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-cli#updatedb)
    * [prep](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-cli#prep)
    * [start](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-cli#start)
    * [stop](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-cli#stop)
    * [kill](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-cli#kill)
    * [armageddon](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-cli#armageddon)
    * [help](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-cli#help)
  * [Using Experiment Templates](https://languagelearninglab.gitbook.io/pushkin/advanced/modifying-experiment-templates)
    * [Lexical decision template](https://languagelearninglab.gitbook.io/pushkin/advanced/modifying-experiment-templates/lexical-decision-template)
    * [Grammaticality judgment template](https://languagelearninglab.gitbook.io/pushkin/advanced/modifying-experiment-templates/grammaticality-judgment-template)
    * [Self-paced reading template](https://languagelearninglab.gitbook.io/pushkin/advanced/modifying-experiment-templates/self-paced-reading-template)
  * [Experiment Structure](https://languagelearninglab.gitbook.io/pushkin/advanced/experiment-structure)
    * [Config File](https://languagelearninglab.gitbook.io/pushkin/advanced/experiment-structure/experiment-config-files)
    * [Experiment Web Page Component](https://languagelearninglab.gitbook.io/pushkin/advanced/experiment-structure/experiment-web-page-component)
    * [Recommended Structure](https://languagelearninglab.gitbook.io/pushkin/advanced/experiment-structure/experiment-web-page-component#recommended-structure)
    * [Customizing the client](https://languagelearninglab.gitbook.io/pushkin/advanced/experiment-structure/experiment-web-page-component#customizing-the-client)
    * [Worker](https://languagelearninglab.gitbook.io/pushkin/advanced/experiment-structure/worker-component-migration-and-seed#experiment-worker-component)
    * [Migrations](https://languagelearninglab.gitbook.io/pushkin/advanced/experiment-structure/worker-component-migration-and-seed#experiment-migrations)
    * [Seeds](https://languagelearninglab.gitbook.io/pushkin/advanced/experiment-structure/worker-component-migration-and-seed#experiment-seeds)
  * [Pushkin Client](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-client)
    * [connect](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-client#connect)
    * [loadScript](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-client#loadscript)
    * [loadScripts](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-client#loadscripts)
    * [prepExperimentRun](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-client#prepexperimentrun)
    * [getAllStimuli](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-client#getallstimuli)
    * [setSaveAfterEachStimulus](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-client#setsaveaftereachstimulus)
    * [saveStimulusResponse](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-client#savestimulusresponse)
    * [insertMetaResponse](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-client#insertmetaresponse)
    * [endExperiment](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-client#endexperiment)
    * [customApiCall](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-client#customapicall)
  * [pushkin-api](https://pushkin-social-science-at-scale.readthedocs.io/en/latest/api/pushkin_api.html)
    * [Controller Builder](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-api/api-controller-builder)
    * [Core API](https://languagelearninglab.gitbook.io/pushkin/advanced/pushkin-api/core-api)
  * [Users & Authentication](https://languagelearninglab.gitbook.io/pushkin/advanced/users-and-authentication)
    * [Generating UserIDs](https://languagelearninglab.gitbook.io/pushkin/advanced/users-and-authentication#generating-userids)
    * [Using UserIDs](https://languagelearninglab.gitbook.io/pushkin/advanced/users-and-authentication#using-userids)
  * [Modifying Site Template](https://languagelearninglab.gitbook.io/pushkin/advanced/modifying-site-template)
    * [React Bootstrap](https://languagelearninglab.gitbook.io/pushkin/advanced/modifying-site-template/react-bootstrap)
    * [Header and Footer](https://languagelearninglab.gitbook.io/pushkin/advanced/modifying-site-template/header-and-footer)
    * [Home Page](https://languagelearninglab.gitbook.io/pushkin/advanced/modifying-site-template/home-page)
    * [Findings Page](https://languagelearninglab.gitbook.io/pushkin/advanced/modifying-site-template/findings-page)
    * [About Page](https://languagelearninglab.gitbook.io/pushkin/advanced/modifying-site-template/about-page)
    * [Feedback Page](https://languagelearninglab.gitbook.io/pushkin/advanced/modifying-site-template/feedback-page)
  * [Deployment](https://github.com/pushkin-consortium/pushkin/blob/main/archive/docs-gitbook/advanced/deploying/README.md)
    * [Deleting AWS](https://languagelearninglab.gitbook.io/pushkin/advanced/deployment/awsdeletion)
* **Developers**
  * [Developing with Pushkin](https://languagelearninglab.gitbook.io/pushkin/developers/developing-with-pushkin)
  * [Getting Started on Development](https://languagelearninglab.gitbook.io/pushkin/developers/getting-started-on-development)
    * [Understanding the Front End](https://languagelearninglab.gitbook.io/pushkin/developers/getting-started-on-development#understanding-the-front-end)
    * [Understanding Docker](https://languagelearninglab.gitbook.io/pushkin/developers/getting-started-on-development#understanding-docker)
    * [Testing Pushkin Modules Locally](https://languagelearninglab.gitbook.io/pushkin/developers/getting-started-on-development#testing-pushkin-modules-locally)
    * [Pushkin jsPsych](https://github.com/pushkin-consortium/pushkin/tree/423120801ce745e971a197dd80d762db002b1749/docs-gitbook/developers/getting-started-on-development/README.md#pushkin-jspsych)
  * [Testing Pushkin with Jest](https://languagelearninglab.gitbook.io/pushkin/developers/testing-pushkin-with-jest)
  * [Working with Templates](https://languagelearninglab.gitbook.io/pushkin/developers/working-with-templates)