Quick Start(For Dojo)

Deploy the Pixel Core locally

Everything in PixeLAW starts with the core pixel layer into which you will deploy your own app.

Let's get started by deploying the core pixel layer, which includes both the contracts and the PixeLAW front-end.

Clone app_template

Please go to app_template. And clone it.

git clone https://github.com/pixelaw/app_template.git app_template

Prerequisites

Download these libraries.

  • Dojo - install here
  • Scarb - install here
  • Docker - install here
  • Docker compose plugin - install here

Run your own tests

To make sure everything is working correctly, run the following command to run tests:

sozo test

Deploy the Pixel Core

We are using devcontainer environments. Please open this code with vscode and launch the container with devcontainer.

Wait for the Core to be deployed (Optional)

For convenience, you can run the following script that will print out "Ready for app deployment", once contracts fully initialised:

scarb run ready_for_deployment

After some time (around 1 minute) you should be able to see PixeLAW running on http://localhost:3000. There is a docker-compose file in this repository specifically for running a local image of PixeLAW core. Wait until http://localhost:3000/manifests/core stops returning NOT FOUND.

You should be able to see PixeLAW in its true glory: PixelCore

If you run into any issues you can check out the github repo, and check out alternatives to deploy the core.

Next Step

Awesome, you just successfully deployed the Pixel Core.

The next step should be for you to build your own PixeLAW App. We will remain in the app_template repo.

Go and be a Pixel Builder and deploy your own App to the core!