ligo/tools/webide/README.md
Maksym Bykovskyy 314b2358db Revised README
2020-03-06 17:35:14 +00:00

1.2 KiB

Quick Start

  1. Install yarn
  2. Run yarn to install dependencies
  3. Install Ligo compiler by following Ligo installation instructions
  4. Go to packages/server/ directory
  5. Run yarn start to start the development server
  6. Open http://localhost:8080

Dependency on Examples

Examples that are displayed in the Web IDE are curated from /src/test/examples folder and packaged during the build of the client. To add a new example to the Web IDE, first add the example file to /src/test/examples folder; it may live under any level of subdirectories. Then, add the path to the example to the CURATED_EXAMPLES array in the packages/client/package-examples.js script. The path has to be relative to /src/test/examples.

Server

The server source code is located under packages/server/. Please see README under packages/server/ for information about how to get started on the server development.

Client

The client source code is located under packages/client/. See the README under the packages/client/ for information about how to get started on the client development.