ligo/tools/webide/README.md

# Quick Start

1. Install `yarn`
1. Run `yarn` to install dependencies
1. Install Ligo compiler by following [Ligo installation instructions][install-ligo]
1. Go to `packages/server/` directory
1. Run `yarn start` to start the development server
1. 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.


[install-ligo]: https://ligolang.org/docs/intro/installation/
Import webide into main ligo monorepo When this is merged https://gitlab.com/ligolang/ligo-web-ide/ will be marked as deprecated. This MR does not hook up the webide build to the main CI. The CI integration will come in a subsequent MR for the sake of making review easier. 2020-02-07 07:04:18 +04:00			`# Quick Start`

Revised README 2020-03-06 21:35:14 +04:00			1. Install `yarn`
			1. Run `yarn` to install dependencies
			`1. Install Ligo compiler by following [Ligo installation instructions][install-ligo]`
			1. Go to `packages/server/` directory
			1. Run `yarn start` to start the development server
			`1. 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`.
Import webide into main ligo monorepo When this is merged https://gitlab.com/ligolang/ligo-web-ide/ will be marked as deprecated. This MR does not hook up the webide build to the main CI. The CI integration will come in a subsequent MR for the sake of making review easier. 2020-02-07 07:04:18 +04:00
			`## Server`

Revised README 2020-03-06 21:35:14 +04:00			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.
Import webide into main ligo monorepo When this is merged https://gitlab.com/ligolang/ligo-web-ide/ will be marked as deprecated. This MR does not hook up the webide build to the main CI. The CI integration will come in a subsequent MR for the sake of making review easier. 2020-02-07 07:04:18 +04:00
			`## Client`

Revised README 2020-03-06 21:35:14 +04:00			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.


			`[install-ligo]: https://ligolang.org/docs/intro/installation/`