getting-started.md

description	Run Piximi locally, the quick and easy way

Getting Started

Install Lerna

We use lerna to organize our project. More in the packages section.

npm i -g lerna

1. Download the Repository

Get the latest master of Piximi from Github

git clone https://github.com/piximi/piximi

You successfully downloaded the newest branch of Piximi. Let's cd into it

cd ./piximi

2. Install all dependencies

Within the newly cloned repository run

yarn bootstrap

This will install all sub repositories which Piximi depend on. However, we still need to build a dist file for each package. This is done by running

yarn build

{% hint style="info" %} Piximi consists of independent sub-repositories found in piximi/packages/@piximi, We use lerna to manage all dependencies. {% endhint %}

3. Run Piximi locally

Almost done! Go to the packages/piximi folder

cd ./packages/piximi

Let's run a local version of the most up-to-date Piximi branch

yarn start

🎉 Congratulations! You should see the newest version of Piximi running locally at: http://localhost:3000/

{% hint style="info" %} Please report any errors or issues you encounter in our tutorial to https://github.com/piximi/piximi-issues {% endhint %}