Pushkin
  • Welcome!
  • Getting Started
    • Installing Pushkin and dependencies
      • macOS
      • Windows 10
        • Windows Subsystem for Linux
        • AWS EC2 Instance
      • Ubuntu Linux
    • Quickstart
      • Quickstart: Example Outputs
    • Deploying to AWS
      • Install required software.
      • Configure the AWS and ECS CLIs.
      • Register a domain.
      • Set up DockerHub.
      • Initialize AWS Deploy.
    • Tutorial: Simple Experiment
  • FAQ
    • FAQ
  • Advanced
    • Pushkin CLI
    • Using Experiment Templates
      • Lexical decision template
      • Grammaticality judgment template
      • Self-paced reading template
    • Experiment Component Structure
      • Experiment Config.yaml Files
      • Experiment Web Page Component
      • Worker Component, Migration, and Seed
    • Modifying Site Template
      • React Bootstrap
      • Header and Footer
      • Home Page
      • Findings Page
      • About Page
      • Feedback Page
    • Troubleshooting Pushkin
    • Pushkin Client
    • pushkin-api
      • API Controller Builder
      • Core API
    • Users & Authentication
    • Deployment
      • Deleting AWS
  • Developers
    • Developing with Pushkin
    • Getting Started on Development
    • Overview of Technologies
    • Testing Pushkin with Jest
    • Working with Templates
Powered by GitBook
On this page
  • Skip to section
  • Install Homebrew
  • Install Node
  • Install Yarn
  • Install Yalc
  • Install pushkin-cli
  • Install Docker
  • Next steps

Was this helpful?

  1. Getting Started
  2. Installing Pushkin and dependencies

macOS

Start here to build install Pushkin and its dependencies on macOS.

PreviousInstalling Pushkin and dependenciesNextWindows 10

Last updated 1 year ago

Was this helpful?

Skip to section

Install Homebrew

If you don’t have , install it. If you do not have Xcode installed yet, this installation will prompt you to install it as well.

Note that Homebrew requires a 64-bit Intel CPU, macOS High Sierra /(10.13/) or higher, Command Line Tools /(CLT/) for Xcode, and a Bourne-compatible shell for installation like bash or zsh.

Install Node

If you don't have an installation of Node yet (you'd know if you did), you should install it:

 brew install node

Install Yarn

Then run the following to get Yarn, which will let you download Pushkin:

 brew install yarn

Install Yalc

Install Yalc globally.

 yarn global add yalc

Install pushkin-cli

Install pushkin-cli package globally.

 yarn global add pushkin-cli

Confirm that pushkin-cli is installed by running:

 pushkin --help

You should get a list of commands with some documentation for each.

Confirm that you have version 2.0.0 or later by running:

 pushkin --version

and reading the output.

Install Docker

Confirm that you have at least Docker Engine 23.0 and Docker Desktop 4.19.

Next steps

Next, install .

Great! You're all done. Head over to build a basic Pushkin site and experiment.

Docker
here
Homebrew
Install Homebrew
Install Yarn
Install pushkin-cli
Install Docker
Next steps