ligo/tools/webide/packages/client
2020-05-21 16:54:17 -07:00
..
public Add nix as a build system 2020-04-29 19:40:04 +01:00
src update example.ts, generate-deploy-script.ts, and load-state.ts to support default generateDeployScript values for examples 2020-05-21 16:54:17 -07:00
.gitignore Import webide into main ligo monorepo 2020-02-06 19:04:18 -08:00
package-examples.js Revised README 2020-03-06 17:35:14 +00:00
package-lock.json Updated package lock file 2020-03-07 18:36:16 -08:00
package.json Tezos client command 2020-03-12 20:26:13 +00:00
README.md Revised README 2020-03-06 17:35:14 +00:00
tsconfig.json Import webide into main ligo monorepo 2020-02-06 19:04:18 -08:00

Quick Start

yarn start
open http://localhost:3000

Note: Some features such as compiler commands and examples will be unavailable. In order to have these features you have to start the server. See README under ../packages/server for details.

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.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you cant go back!

If you arent satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point youre on your own.

You dont have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldnt feel obligated to use this feature. However we understand that this tool wouldnt be useful if you couldnt customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.