Piximi
  • Piximi
  • Development
    • How to develop for Piximi
      • Getting Started
      • Packages
      • React
      • Scripts & Lerna
      • FAQ
Powered by GitBook
On this page
  • Install Lerna
  • 1. Download the Repository
  • 2. Install all dependencies
  • 3. Run Piximi locally

Was this helpful?

Export as PDF
  1. Development
  2. How to develop for Piximi

Getting Started

Run Piximi locally, the quick and easy way

PreviousHow to develop for PiximiNextPackages

Last updated 4 years ago

Was this helpful?

Install Lerna

We use 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

Piximi consists of independent sub-repositories found in piximi/packages/@piximi, We use to manage all dependencies.

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:

Please report any errors or issues you encounter in our tutorial to

lerna
lerna
🎉
http://localhost:3000/
https://github.com/piximi/piximi-issues