https://github.com/stencila/demo-codespace
Demonstration of the Stencila VSCode Extension using GitHub Codespaces
https://github.com/stencila/demo-codespace
Last synced: 4 months ago
JSON representation
Demonstration of the Stencila VSCode Extension using GitHub Codespaces
- Host: GitHub
- URL: https://github.com/stencila/demo-codespace
- Owner: stencila
- License: apache-2.0
- Created: 2024-10-22T23:33:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-18T17:03:37.000Z (over 1 year ago)
- Last Synced: 2025-10-13T21:01:21.592Z (8 months ago)
- Language: Dockerfile
- Size: 35.2 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stencila VSCode Extension Demo
This demo creates a prepared Dockerized environment for testing Stencila, Stencila VSCode and Stencila Cloud without any changes to your workstation's environment. Stencila can also run locally by simply installing the [Stencila VSCode extension](https://marketplace.visualstudio.com/items?itemName=stencila.stencila) in VSCode. The demo environment described below is an alternative available for those who do not want to install VSCode, but want to test out Stencila and Stencila Cloud.
## Two ways to run :
### 1. Launching the demo in the Cloud (EASY!)
Our free tier will let you experiment with Stencila and try out our walkthroughs, or test on your own documents.
You can launch the demo, in a data center near you, by clicking this button:
[](https://codespaces.new/stencila/demo-codespace?quickstart=1)
### 2. Launching the demo Locally using Docker and Dev Container (more steps)
Expand to see Instructions
This repository has a [Dev Container](https://containers.dev/) defined in the `.devcontainer` directory of the repository. This defines a container that can run Stencila and the associated Stencila VSCode extension on your local machine in a containerized environment. To run locally (requires Docker).
1. Install VSCode or have it already installed
2. Install Docker or have it already installed
3. Install the [Dev Container Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in VSCode
4. `git clone https://github.com/stencila/demo-codespace`
5. `cd demo-codespace`
6. `code .`
7. Chose "Reopen in Container from the pop-up in VSCode"
## Interactive walkthroughs
When the Codespace is open we recommend trying one of our interactive walkthroughs. Press F2 to bring up the Stencila command palette and select from one of the walkthroughs.
## Installed languages and packages
This Codespace includes Python and R with popular data science packages installed:
- Python: `numpy`, `matplotlib`, `pandas`, `requests`
- R: `tidyverse`
If you think we should add other languages or packages [create an issue](https://github.com/stencila/demo-codespace/issues/new), or submit a PR with changes to the [Dockerfile](https://github.com/stencila/demo-codespace/edit/main/.devcontainer/Dockerfile).
## Customizing the Codespace
You can [create a fork](https://github.com/stencila/demo-codespace/fork) of this repository and modify the following files to customize the environment:
- add language runtimes and packages to `.devcontainer/Dockerfile`
- add VSCode extensions to `.devcontainer/devcontainer.json`
We are [planning](https://github.com/stencila/demo-codespace/issues/3) to make it easier to fork and customize this repository in the future.