https://github.com/amphitheatre-app/playground
Embedded Code runner in web pages, supports multiple programming languages.
https://github.com/amphitheatre-app/playground
code-runner editor embedded frontend javascript playground typescript webapp
Last synced: 6 days ago
JSON representation
Embedded Code runner in web pages, supports multiple programming languages.
- Host: GitHub
- URL: https://github.com/amphitheatre-app/playground
- Owner: amphitheatre-app
- License: apache-2.0
- Created: 2023-12-01T09:18:05.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-08T06:29:20.000Z (about 1 year ago)
- Last Synced: 2025-02-08T07:25:02.908Z (about 1 year ago)
- Topics: code-runner, editor, embedded, frontend, javascript, playground, typescript, webapp
- Language: TypeScript
- Homepage:
- Size: 374 KB
- Stars: 13
- Watchers: 5
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Amphitheatre Playground
[](https://github.com/amphitheatre-app/playground/blob/master/LICENSE)
[](https://github.com/amphitheatre-app/playground/graphs/contributors)
[](https://github.com/amphitheatre-app/playground/issues)
[What's it do?](#whats-it-do) •
[Architecture](#architecture) •
[Usage](#usage) •
[Development](#local-development) •
[Contributing](#contributing) •
[简体中文](README.zh-CN.md)
## What's it do?
Embedded Code runner in web pages, supports multiple programming languages. You
can check demo and read more about features
[here](https://play.amphitheatre.app).
It has a number of features, including:
- A nice, unobtrusive editor with syntax highlighting.
- Supports multiple programming languages, included its build tools.
- The ability to quickly load preview for predefined code from a GitHub Project or Gist.
- See console output in the component itself.
## Architecture
A React frontend communicates with an [Axum
backend](https://github.com/amphitheatre-app/playground-api). Docker containers
are used to provide the various compilers and tools as well as to help isolate
them.
## Usage
The Playground may be included on your site in one of two ways:
### As a React Component
If you are using React, then you can add the
[playground-react](https://github.com/amphitheatre-app/playground-react)
component directly in your project, as simple as the following:
```shell
npm install --save @amphitheatre/playground-react
```
```javascript
import Playground from '@amphitheatre/playground-react'
export default function App() {
return
}
```
### As an iframe
If you're not using React, please deploy the project and backend server
privately first, then include the Playground in an `iframe`.
```html
```
#### Parameters
The Playground accepts the following props/parameters.
| Title | Description | Default |
| ---------------- | ------------------------------------------------------------ | ---------------------- |
| **`title`** | An optional title for the editor pane. | `''` |
| **`files`** | A map of `{ [filename]: code }`. This will take precedence over `code` if given. | `undefined` |
| **`entry`** | The filename of the file that runs first. This is only relevant when showing multiple files with the `files` parameter. | `''` |
| **`initialTab`** | The filename of the tab to show by default. This is only relevant when showing multiple files with the `files` parameter. Defaults to the value of `entry`. | `entry` |
| **`styles`** | An map of inline style objects, applied to various elements to customize the style of the UI. Example: `{ header: { backgroundColor: 'red' } }` | `{}` |
| **`fullscreen`** | Show a button to enable fullscreen editing (in most configurations of panes). Note that the iframe must have the `allowfullscreen` attribute for this to work. | `false` |
| **`panes`** | An array of UI panes to display. To display a pane without options, use a string. Otherwise, use an object with a `type` property. The available panes are: `'stack'`, `'editor'`, `'player'`, `'console'`. Note that there *must be* a `player` pane for any code to run. For pane options, see below. | `['editor', 'player']` |
## Local development
To run the playground locally, run:
- `pnpm` to install dependencies
- `pnpm build` to compile the app and place it in the `build/` directory
- `pnpm start` to serve from the `build/` directory and open a page on your
browser.
For a fast edit-refresh cycle when developing run `pnpm dev`. This will
start an http server and automatically re-compile the TypeScript, HTML and CSS
files whenever they change.
## Local development with Docker-compose
- Make sure you have [docker](https://docs.docker.com/get-docker/) installed.
- Clone or fork this repository.
- Start server `docker-compose up`, add `-d` to `docker-compose up` if you'd
like to run it in the background.
The first time will take some time to download the dependencies. they are
downloaded only once, and then cached.
## Development with Amphitheatre
Just like the other [Amphitheatre
examples](https://docs.amphitheatre.app/examples/), after [installing the server
and CLI software](https://docs.amphitheatre.app/installation/), and [configuring
the certificates and
preferences](https://docs.amphitheatre.app/getting-started/initialize/), Execute
the following command:
```bash
amp run
```
## Contributing
If anything feels off, or if you feel that some functionality is missing, please
check out the [contributing page](https://docs.amphitheatre.app/contributing/).
There you will find instructions for sharing your feedback, building the tool
locally, and submitting pull requests to the project.
**This project is based on the Web3 Open Source General Playground product
developed by Amphitheatre, which aims to help developers learn Web3 development
better, and is co-sponsored by [Amphitheatre](https://amphitheatre.app/) and
[OpenBuild](https://openbuild.xyz).**
**We will post some development tasks as task topics and label them as "Tasks",
interested partners can evaluate the development time in the corresponding
topics, we will pick the most suitable developer from them and assign the task
to him, and we will give rewards after the task is completed and passes the PR.**
For more information, please refer to [How to
Contribute](https://github.com/amphitheatre-app/playground/blob/master/docs/how_to_contribute.md)
and the [Contribution Reward
Announcement](https://github.com/amphitheatre-app/playground/issues/4).
## Contributors
King
IanXu
xiangnuans
GrayJiang
Eguo Wang
Challenger
KazooTTT
DEthan3
Null
Null
## License
Copyright (c) The Amphitheatre Authors. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.