Getting Started

System Requirements

Install System Dependencies

Skip to installing Particle if you already have Node, NPM, PHP installed.

Run source ~/.bashrc or source ~/.zshrc after each step to ensure command is registered

OS-specific Instructions

macOS
Windows
Debian

Install Homebrew

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Update Homebrew

brew update && brew upgrade

Install PHP 7.2

brew install php72

Use WSL ("Bash on Ubuntu on Windows"), then follow the Debian instructions.

This guide also works on Debian-based distros like Ubuntu, Mint, etc.

Update APT

sudo apt-get update && apt-get upgrade

Install PHP 7.2

sudo apt-get install php7.2 php7.2-common

Install NVM

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash

Install Node 10

This sets the system-wide Node to v10.

nvm install v10 && nvm alias default v10

Install NPM

npm install -g npm@latest

Install Particle

Via NPM
Via Git
npm create @phase2/particle particle && cd particle
git clone git@github.com:phase2/particle.git && cd particle

Install Particle Dependencies

Run this at the start of a project and any time package.json changes.

npm install && npm run setup

Start Particle

npm start

Open Particle

Simply visit http://0.0.0.0:8080/pl or http://localhost:8080/pl and start editing files!