Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

Update README #334

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@
</p>
</figure>

An ink! Playground which provides a Browser based IDE for editing Smart Contracts written in [ink!](https://github.com/paritytech/ink). A live deployment of the App can be found under [ink-playground.substrate.io](https://ink-playground.substrate.io).
With ink! Playground you can write and compile [ink!](https://github.com/paritytech/ink) smart contracts in the browser. It uses the [Monaco editor](https://microsoft.github.io/monaco-editor/) under the hood and runs a WebAssembly version of [Rust Analyzer](https://rust-analyzer.github.io/) to provide editor language features for your Rust code.

Features:
A live deployment can be found at [ink-playground.substrate.io](https://ink-playground.substrate.io).

- Uses the [Monaco editor](https://microsoft.github.io/monaco-editor/)
- Implements a WebAssembly version of [Rust Analyzer](https://rust-analyzer.github.io/) for code editing
- Allows saving and sharing of Smart Contract code
- Implements a one click compile functionality of ink! Smart Contracts to WASM which is provided by a backend service
Includes:

- One click compile to WASM functionality for ink! Smart Contracts, provided by a backend service
- Code completion and goto definition
- Compiled contract file download
- Rust source code sharing through URL or GitHub gists

## Table of Contents

Expand All @@ -39,7 +41,7 @@ The backend serves the frontend app and it also provides the backend services fo

To clone and build the whole project on your local machine, enter:

1. `git clone clone https://github.com/paritytech/ink-playground`
1. `git clone https://github.com/paritytech/ink-playground`

2. `cd ink-playground`

Expand Down
22 changes: 17 additions & 5 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Manual changes might be lost - proceed with caution!

__metadata:
version: 5
version: 6
cacheKey: 8

"@ampproject/remapping@npm:^2.1.0":
Expand Down Expand Up @@ -4315,7 +4315,7 @@ __metadata:
languageName: node
linkType: hard

"chalk@npm:^2.0.0":
"chalk@npm:^2.0.0, chalk@npm:^2.4.1":
version: 2.4.2
resolution: "chalk@npm:2.4.2"
dependencies:
Expand Down Expand Up @@ -9294,6 +9294,7 @@ __metadata:
dependencies:
glob: ^7.1.2
object-assign: ^4.1.1
postcss: ^6.0.9
postcss-value-parser: ^3.3.0
checksum: f276849375a17c43eb89e1256d8e99bf47e0506d0653618e496168da2a694196f73c545387cccac6bfe08213b3fdeeb7576586193a99bf1eb8acc985095e0823
languageName: node
Expand Down Expand Up @@ -9727,6 +9728,17 @@ __metadata:
languageName: node
linkType: hard

"postcss@npm:^6.0.9":
version: 6.0.23
resolution: "postcss@npm:6.0.23"
dependencies:
chalk: ^2.4.1
source-map: ^0.6.1
supports-color: ^5.4.0
checksum: cc6cb2c1dbcdefa6f57a71d67fe535c9e96543298bbe28f9a6a64c4f1e21b6127113890dd4cda8873d3f4e6613a0566b7b4bbb230204f3a9a309190bda065d81
languageName: node
linkType: hard

"postcss@npm:^7, postcss@npm:^7.0.18, postcss@npm:^7.0.32":
version: 7.0.39
resolution: "postcss@npm:7.0.39"
Expand Down Expand Up @@ -11011,7 +11023,7 @@ __metadata:
languageName: node
linkType: hard

"supports-color@npm:^5.3.0":
"supports-color@npm:^5.3.0, supports-color@npm:^5.4.0":
version: 5.5.0
resolution: "supports-color@npm:5.5.0"
dependencies:
Expand Down Expand Up @@ -11499,11 +11511,11 @@ __metadata:

"typescript@patch:typescript@^4.7.4#~builtin<compat/typescript>":
version: 4.7.4
resolution: "typescript@patch:typescript@npm%3A4.7.4#~builtin<compat/typescript>::version=4.7.4&hash=ddd1e8"
resolution: "typescript@patch:typescript@npm%3A4.7.4#~builtin<compat/typescript>::version=4.7.4&hash=f456af"
bin:
tsc: bin/tsc
tsserver: bin/tsserver
checksum: 96d3030cb01143570567cb4f3a616b10df65f658f0e74e853e77a089a6a954e35c800be7db8b9bfe9a1ae05d9c2897e281359f65e4caa1caf266368e1c4febd3
checksum: 9096d8f6c16cb80ef3bf96fcbbd055bf1c4a43bd14f3b7be45a9fbe7ada46ec977f604d5feed3263b4f2aa7d4c7477ce5f9cd87de0d6feedec69a983f3a4f93e
languageName: node
linkType: hard

Expand Down